From 068a14cbcd36dc9b3ad721d418d4296ec4c65d4e Mon Sep 17 00:00:00 2001 From: Sebastian Kaspari Date: Tue, 12 Feb 2019 15:28:04 +0100 Subject: [PATCH] Issue #1995: Add initial API documentation. --- docs/api/alltypes/index.md | 398 ++++++++++++++++++ docs/api/index.md | 136 ++++++ .../-default-suggestion-layout/-init-.md | 8 + .../create-view-holder.md | 11 + .../get-layout-resource.md | 11 + .../-default-suggestion-layout/index.md | 20 + .../-suggestion-layout/create-view-holder.md | 9 + .../-suggestion-layout/get-layout-resource.md | 9 + .../-suggestion-layout/index.md | 22 + .../-suggestion-view-holder/-init-.md | 8 + .../-suggestion-view-holder/bind.md | 12 + .../-suggestion-view-holder/index.md | 25 ++ .../-suggestion-view-holder/view.md | 5 + .../index.md | 11 + .../-suggestion-transformer/index.md | 16 + .../-suggestion-transformer/transform.md | 9 + .../index.md | 9 + .../-browser-awesome-bar/-init-.md | 8 + .../-browser-awesome-bar/add-providers.md | 10 + .../-browser-awesome-bar/index.md | 56 +++ .../-browser-awesome-bar/layout.md | 8 + .../on-detached-from-window.md | 5 + .../on-input-cancelled.md | 10 + .../-browser-awesome-bar/on-input-changed.md | 13 + .../-browser-awesome-bar/on-input-started.md | 10 + .../set-on-stop-listener.md | 11 + .../-browser-awesome-bar/transformer.md | 9 + .../index.md | 9 + .../-init-.md | 8 + .../domains.md | 5 + .../get-autocomplete-suggestion.md | 18 + .../index.md | 33 ++ .../initialize.md | 5 + .../-custom-domains-provider/-init-.md | 8 + .../-custom-domains-provider/index.md | 31 ++ .../-custom-domains-provider/initialize.md | 8 + .../get-autocomplete-suggestion.md | 5 + .../-domain-autocomplete-provider/index.md | 17 + .../-domain-autocomplete-result/-init-.md | 8 + .../-domain-autocomplete-result/index.md | 23 + .../-domain-autocomplete-result/input.md | 11 + .../-domain-autocomplete-result/source.md | 11 + .../-domain-autocomplete-result/text.md | 11 + .../total-items.md | 11 + .../-domain-autocomplete-result/url.md | 11 + .../-domain-list/-c-u-s-t-o-m.md | 11 + .../-domain-list/-d-e-f-a-u-l-t.md | 11 + .../-domain-list/index.md | 18 + .../-domain-list/list-name.md | 5 + .../-shipped-domains-provider/-init-.md | 8 + .../-shipped-domains-provider/index.md | 31 ++ .../-shipped-domains-provider/initialize.md | 8 + .../index.md | 14 + .../-custom-domains/add.md | 13 + .../-custom-domains/index.md | 16 + .../-custom-domains/load.md | 15 + .../-custom-domains/remove.md | 13 + .../-custom-domains/save.md | 13 + .../-c-u-s-t-o-m_-l-i-s-t.md | 5 + .../-d-e-f-a-u-l-t_-l-i-s-t.md | 5 + .../-autocomplete-source/index.md | 12 + .../-domain-auto-complete-provider/-init-.md | 10 + .../-result/-init-.md | 8 + .../-result/index.md | 22 + .../-result/size.md | 13 + .../-result/source.md | 11 + .../-result/text.md | 13 + .../-result/url.md | 13 + .../autocomplete.md | 17 + .../-domain-auto-complete-provider/index.md | 30 ++ .../initialize.md | 21 + .../-domain/-init-.md | 8 + .../-domain/create.md | 5 + .../-domain/has-www.md | 5 + .../-domain/host.md | 5 + .../-domain/index.md | 27 ++ .../-domain/protocol.md | 5 + .../-domains/index.md | 14 + .../-domains/load.md | 16 + .../index.md | 12 + .../-byte-buffer-input-stream/-init-.md | 5 + .../-byte-buffer-input-stream/index.md | 17 + .../-byte-buffer-input-stream/read.md | 6 + .../-gecko-view-fetch-client/-init-.md | 8 + ..._-r-e-a-d_-t-i-m-e-o-u-t_-m-i-n-u-t-e-s.md | 5 + .../-gecko-view-fetch-client/fetch.md | 35 ++ .../-gecko-view-fetch-client/index.md | 31 ++ .../index.md | 10 + .../-gecko-permission-request/-app/-init-.md | 8 + .../-gecko-permission-request/-app/index.md | 38 ++ .../-app/permissions-map.md | 5 + .../-gecko-permission-request/-app/uri.md | 13 + .../-content/-init-.md | 8 + .../-content/index.md | 38 ++ .../-content/permissions-map.md | 5 + .../-gecko-permission-request/-content/uri.md | 13 + .../-media/-init-.md | 8 + .../contains-video-and-audio-sources.md | 8 + .../-gecko-permission-request/-media/grant.md | 14 + .../-gecko-permission-request/-media/index.md | 39 ++ .../-media/map-permission.md | 5 + .../-media/reject.md | 10 + .../-gecko-permission-request/-media/uri.md | 13 + .../-gecko-permission-request/grant.md | 14 + .../-gecko-permission-request/index.md | 49 +++ .../-gecko-permission-request/permissions.md | 13 + .../-gecko-permission-request/reject.md | 10 + .../index.md | 9 + .../-gecko-choice.md | 5 + .../index.md | 9 + .../from-j-s-o-n.md | 5 + .../-gecko-engine-session-state/index.md | 17 + .../-gecko-engine-session-state/to-j-s-o-n.md | 13 + .../-gecko-engine-session/-init-.md | 13 + .../capture-thumbnail.md | 10 + .../-gecko-engine-session/clear-data.md | 10 + .../clear-find-matches.md | 10 + .../-gecko-engine-session/close.md | 10 + .../coroutine-context.md | 5 + .../disable-tracking-protection.md | 10 + .../enable-tracking-protection.md | 10 + .../exit-full-screen-mode.md | 10 + .../-gecko-engine-session/find-all.md | 10 + .../-gecko-engine-session/find-next.md | 10 + .../-gecko-engine-session/go-back.md | 10 + .../-gecko-engine-session/go-forward.md | 10 + .../handle-long-click.md | 5 + .../-gecko-engine-session/index.md | 49 +++ .../-gecko-engine-session/load-data.md | 10 + .../-gecko-engine-session/load-url.md | 10 + .../-gecko-engine-session/reload.md | 10 + .../-gecko-engine-session/restore-state.md | 10 + .../-gecko-engine-session/save-state.md | 17 + .../-gecko-engine-session/settings.md | 10 + .../-gecko-engine-session/stop-loading.md | 10 + .../toggle-desktop-mode.md | 10 + .../-gecko-engine-view/-init-.md | 8 + .../can-scroll-vertically-down.md | 11 + .../-gecko-engine-view/index.md | 51 +++ .../-gecko-engine-view/render.md | 10 + .../-gecko-engine/-init-.md | 8 + .../-gecko-engine/create-session-state.md | 10 + .../-gecko-engine/create-session.md | 10 + .../-gecko-engine/create-view.md | 10 + .../-gecko-engine/index.md | 29 ++ .../-gecko-engine/name.md | 15 + .../-gecko-engine/settings.md | 10 + .../-gecko-engine/speculative-connect.md | 13 + .../-nested-gecko-view/-init-.md | 15 + .../dispatch-nested-fling.md | 5 + .../dispatch-nested-pre-fling.md | 5 + .../dispatch-nested-pre-scroll.md | 5 + .../dispatch-nested-scroll.md | 5 + .../has-nested-scrolling-parent.md | 5 + .../-nested-gecko-view/index.md | 54 +++ .../is-nested-scrolling-enabled.md | 5 + .../-nested-gecko-view/on-touch-event.md | 5 + .../set-nested-scrolling-enabled.md | 5 + .../-nested-gecko-view/start-nested-scroll.md | 5 + .../-nested-gecko-view/stop-nested-scroll.md | 5 + .../index.md | 13 + .../-servo-engine-session-state/-init-.md | 8 + .../from-j-s-o-n.md | 5 + .../-servo-engine-session-state/index.md | 25 ++ .../-servo-engine-session-state/to-j-s-o-n.md | 13 + .../-servo-engine-session/-init-.md | 8 + .../capture-thumbnail.md | 10 + .../-servo-engine-session/clear-data.md | 10 + .../clear-find-matches.md | 10 + .../disable-tracking-protection.md | 10 + .../enable-tracking-protection.md | 13 + .../exit-full-screen-mode.md | 10 + .../-servo-engine-session/find-all.md | 13 + .../-servo-engine-session/find-next.md | 14 + .../-servo-engine-session/go-back.md | 10 + .../-servo-engine-session/go-forward.md | 10 + .../-servo-engine-session/index.md | 47 +++ .../-servo-engine-session/load-data.md | 29 ++ .../-servo-engine-session/load-url.md | 10 + .../-servo-engine-session/reload.md | 10 + .../-servo-engine-session/restore-state.md | 13 + .../-servo-engine-session/save-state.md | 15 + .../-servo-engine-session/settings.md | 10 + .../-servo-engine-session/stop-loading.md | 10 + .../toggle-desktop-mode.md | 10 + .../-servo-engine-view/-init-.md | 8 + .../-servo-engine-view/index.md | 51 +++ .../-servo-engine-view/on-pause.md | 11 + .../-servo-engine-view/on-resume.md | 11 + .../-servo-engine-view/render.md | 10 + .../-servo-engine/-init-.md | 8 + .../-servo-engine/create-session-state.md | 10 + .../-servo-engine/create-session.md | 17 + .../-servo-engine/create-view.md | 19 + .../-servo-engine/index.md | 29 ++ .../-servo-engine/name.md | 15 + .../-servo-engine/settings.md | 10 + .../-servo-engine/speculative-connect.md | 12 + .../index.md | 12 + .../-reversible-string/char-at.md | 5 + .../-reversible-string/create.md | 8 + .../-reversible-string/index.md | 35 ++ .../-reversible-string/is-reversed.md | 5 + .../-reversible-string/length.md | 8 + .../-reversible-string/offset-end.md | 5 + .../-reversible-string/offset-start.md | 5 + .../-reversible-string/reverse.md | 8 + .../-reversible-string/string.md | 5 + .../-reversible-string/substring.md | 5 + .../-trie/-init-.md | 8 + .../-trie/children.md | 5 + .../-trie/create-node.md | 13 + .../-trie/create-root-node.md | 8 + .../-trie/find-node.md | 16 + .../-trie/index.md | 33 ++ .../-trie/put.md | 27 ++ .../-url-matcher/-a-d-v-e-r-t-i-s-i-n-g.md | 5 + .../-url-matcher/-a-n-a-l-y-t-i-c-s.md | 5 + .../-url-matcher/-c-o-n-t-e-n-t.md | 5 + .../-url-matcher/-d-e-f-a-u-l-t.md | 5 + .../-url-matcher/-d-i-s-c-o-n-n-e-c-t.md | 5 + .../-url-matcher/-init-.md | 5 + .../-url-matcher/-s-o-c-i-a-l.md | 5 + .../-url-matcher/create-matcher.md | 25 ++ .../-url-matcher/index.md | 39 ++ .../-url-matcher/is-web-font.md | 15 + .../-url-matcher/matches.md | 16 + .../-url-matcher/set-categories-enabled.md | 11 + .../index.md | 17 + .../kotlin.-string/index.md | 8 + .../kotlin.-string/reverse.md | 5 + .../kotlin.-string/reversible.md | 5 + .../-system-permission-request/-init-.md | 8 + .../-system-permission-request/grant.md | 14 + .../-system-permission-request/index.md | 40 ++ .../permissions-map.md | 5 + .../-system-permission-request/permissions.md | 10 + .../-system-permission-request/reject.md | 10 + .../-system-permission-request/uri.md | 10 + .../index.md | 9 + .../-system-window-request/-init-.md | 8 + .../-system-window-request/index.md | 28 ++ .../-system-window-request/open-as-dialog.md | 11 + .../-system-window-request/prepare.md | 14 + .../-system-window-request/start.md | 10 + .../triggered-by-user.md | 11 + .../-system-window-request/url.md | 12 + .../index.md | 9 + .../-nested-web-view/-init-.md | 15 + .../-nested-web-view/dispatch-nested-fling.md | 5 + .../dispatch-nested-pre-fling.md | 5 + .../dispatch-nested-pre-scroll.md | 5 + .../dispatch-nested-scroll.md | 5 + .../has-nested-scrolling-parent.md | 5 + .../-nested-web-view/index.md | 54 +++ .../is-nested-scrolling-enabled.md | 5 + .../-nested-web-view/on-touch-event.md | 5 + .../set-nested-scrolling-enabled.md | 5 + .../-nested-web-view/start-nested-scroll.md | 5 + .../-nested-web-view/stop-nested-scroll.md | 5 + .../-system-engine-session-state/-init-.md | 5 + .../from-j-s-o-n.md | 5 + .../-system-engine-session-state/index.md | 23 + .../to-j-s-o-n.md | 13 + .../-system-engine-session/-init-.md | 8 + .../-web-setting/-init-.md | 5 + .../-web-setting/get-value.md | 5 + .../-web-setting/index.md | 18 + .../-web-setting/set-value.md | 5 + .../capture-thumbnail.md | 10 + .../-system-engine-session/clear-data.md | 10 + .../clear-find-matches.md | 10 + .../-system-engine-session/close.md | 10 + .../disable-tracking-protection.md | 10 + .../enable-tracking-protection.md | 10 + .../exit-full-screen-mode.md | 10 + .../-system-engine-session/find-all.md | 10 + .../-system-engine-session/find-next.md | 10 + .../-system-engine-session/go-back.md | 10 + .../-system-engine-session/go-forward.md | 10 + .../-system-engine-session/index.md | 49 +++ .../-system-engine-session/load-data.md | 10 + .../-system-engine-session/load-url.md | 10 + .../-system-engine-session/reload.md | 10 + .../-system-engine-session/restore-state.md | 10 + .../-system-engine-session/save-state.md | 10 + .../-system-engine-session/settings.md | 10 + .../-system-engine-session/stop-loading.md | 10 + .../toggle-desktop-mode.md | 10 + .../-system-engine-session/web-view.md | 5 + .../-image-handler/-init-.md | 5 + .../-image-handler/handle-message.md | 5 + .../-image-handler/index.md | 23 + .../-image-handler/session.md | 5 + .../-system-engine-view/-init-.md | 8 + .../can-scroll-vertically-down.md | 11 + .../-system-engine-view/index.md | 58 +++ .../-system-engine-view/on-destroy.md | 11 + .../-system-engine-view/on-long-click.md | 5 + .../-system-engine-view/on-pause.md | 11 + .../-system-engine-view/on-resume.md | 11 + .../-system-engine-view/render.md | 10 + .../-system-engine/-init-.md | 8 + .../-system-engine/create-session-state.md | 10 + .../-system-engine/create-session.md | 10 + .../-system-engine/create-view.md | 10 + .../-system-engine/default-user-agent.md | 5 + .../-system-engine/index.md | 35 ++ .../-system-engine/name.md | 10 + .../-system-engine/settings.md | 10 + .../-system-engine/speculative-connect.md | 12 + .../index.md | 13 + .../-error-pages/create-error-page.md | 8 + .../-error-pages/index.md | 11 + ...o-r_-c-o-n-n-e-c-t-i-o-n_-r-e-f-u-s-e-d.md | 12 + ...e-r-r-o-r_-c-o-n-t-e-n-t_-c-r-a-s-h-e-d.md | 12 + ...r-o-r_-c-o-r-r-u-p-t-e-d_-c-o-n-t-e-n-t.md | 12 + ...-o-r_-f-i-l-e_-a-c-c-e-s-s_-d-e-n-i-e-d.md | 12 + .../-e-r-r-o-r_-f-i-l-e_-n-o-t_-f-o-u-n-d.md | 12 + ...a-l-i-d_-c-o-n-t-e-n-t_-e-n-c-o-d-i-n-g.md | 12 + .../-e-r-r-o-r_-m-a-l-f-o-r-m-e-d_-u-r-i.md | 12 + .../-e-r-r-o-r_-n-e-t_-i-n-t-e-r-r-u-p-t.md | 12 + .../-e-r-r-o-r_-n-e-t_-r-e-s-e-t.md | 12 + .../-e-r-r-o-r_-n-e-t_-t-i-m-e-o-u-t.md | 12 + .../-error-type/-e-r-r-o-r_-o-f-f-l-i-n-e.md | 12 + .../-e-r-r-o-r_-p-o-r-t_-b-l-o-c-k-e-d.md | 12 + ...x-y_-c-o-n-n-e-c-t-i-o-n_-r-e-f-u-s-e-d.md | 12 + .../-e-r-r-o-r_-r-e-d-i-r-e-c-t_-l-o-o-p.md | 12 + ...e-b-r-o-w-s-i-n-g_-h-a-r-m-f-u-l_-u-r-i.md | 12 + ...e-b-r-o-w-s-i-n-g_-m-a-l-w-a-r-e_-u-r-i.md | 12 + ...b-r-o-w-s-i-n-g_-p-h-i-s-h-i-n-g_-u-r-i.md | 12 + ...b-r-o-w-s-i-n-g_-u-n-w-a-n-t-e-d_-u-r-i.md | 12 + ...-r-o-r_-s-e-c-u-r-i-t-y_-b-a-d_-c-e-r-t.md | 12 + .../-e-r-r-o-r_-s-e-c-u-r-i-t-y_-s-s-l.md | 12 + .../-e-r-r-o-r_-u-n-k-n-o-w-n_-h-o-s-t.md | 12 + ...r-r-o-r_-u-n-k-n-o-w-n_-p-r-o-t-o-c-o-l.md | 12 + ...-o-r_-u-n-k-n-o-w-n_-p-r-o-x-y_-h-o-s-t.md | 12 + ...-r_-u-n-k-n-o-w-n_-s-o-c-k-e-t_-t-y-p-e.md | 12 + ...-r_-u-n-s-a-f-e_-c-o-n-t-e-n-t_-t-y-p-e.md | 12 + .../-error-type/-u-n-k-n-o-w-n.md | 12 + .../-error-type/index.md | 45 ++ .../-error-type/message-res.md | 5 + .../-error-type/title-res.md | 5 + .../index.md | 10 + .../-browser-menu-checkbox/-init-.md | 15 + .../get-layout-resource.md | 11 + .../-browser-menu-checkbox/index.md | 39 ++ .../-browser-menu-compound-button/-init-.md | 16 + .../-browser-menu-compound-button/bind.md | 10 + .../-browser-menu-compound-button/index.md | 47 +++ .../-browser-menu-compound-button/visible.md | 11 + .../-browser-menu-divider/-init-.md | 8 + .../-browser-menu-divider/bind.md | 10 + .../get-layout-resource.md | 11 + .../-browser-menu-divider/index.md | 26 ++ .../-browser-menu-divider/visible.md | 11 + .../-browser-menu-image-text/-init-.md | 19 + .../-browser-menu-image-text/bind.md | 10 + .../get-layout-resource.md | 11 + .../-browser-menu-image-text/index.md | 38 ++ .../-browser-menu-image-text/visible.md | 11 + .../-button/-init-.md | 17 + .../-button/content-description.md | 8 + .../-button/icon-tint-color-resource.md | 8 + .../-button/image-resource.md | 8 + .../-button/index.md | 32 ++ .../-button/listener.md | 8 + .../-browser-menu-item-toolbar/-init-.md | 8 + .../-browser-menu-item-toolbar/bind.md | 10 + .../get-layout-resource.md | 11 + .../-browser-menu-item-toolbar/index.md | 32 ++ .../-browser-menu-item-toolbar/visible.md | 11 + .../-browser-menu-switch/-init-.md | 15 + .../get-layout-resource.md | 11 + .../-browser-menu-switch/index.md | 39 ++ .../-simple-browser-menu-item/-init-.md | 13 + .../-simple-browser-menu-item/bind.md | 10 + .../get-layout-resource.md | 11 + .../-simple-browser-menu-item/index.md | 32 ++ .../-simple-browser-menu-item/visible.md | 11 + .../index.md | 15 + .../-browser-menu-builder/-init-.md | 11 + .../-browser-menu-builder/build.md | 5 + .../-browser-menu-builder/index.md | 29 ++ .../-browser-menu-builder/items.md | 8 + .../-browser-menu-item-view-holder/-init-.md | 5 + .../-browser-menu-item-view-holder/index.md | 11 + .../-browser-menu-item/bind.md | 8 + .../-browser-menu-item/get-layout-resource.md | 9 + .../-browser-menu-item/index.md | 30 ++ .../-browser-menu-item/visible.md | 9 + .../-browser-menu/-orientation/-d-o-w-n.md | 5 + .../-browser-menu/-orientation/-u-p.md | 5 + .../-browser-menu/-orientation/index.md | 12 + .../determine-menu-orientation.md | 8 + .../-browser-menu/dismiss.md | 5 + .../-browser-menu/index.md | 26 ++ .../-browser-menu/show.md | 5 + .../mozilla.components.browser.menu/index.md | 12 + .../-search-engine-filter/filter.md | 9 + .../-search-engine-filter/index.md | 14 + .../index.md | 9 + .../-init-.md | 9 + .../country.md | 12 + .../index.md | 28 ++ .../language.md | 13 + .../region.md | 17 + .../-search-localization-provider/-init-.md | 9 + .../-search-localization-provider/country.md | 10 + .../-search-localization-provider/index.md | 29 ++ .../language-tag.md | 10 + .../-search-localization-provider/language.md | 11 + .../-search-localization-provider/region.md | 15 + .../index.md | 10 + .../-assets-search-engine-provider/-init-.md | 17 + .../-assets-search-engine-provider/index.md | 28 ++ .../load-search-engines.md | 10 + .../-search-engine-provider/index.md | 19 + .../load-search-engines.md | 8 + .../index.md | 10 + .../-j-s-o-n-response.md | 9 + .../-response-parser.md | 5 + .../-fetch-exception/-init-.md | 8 + .../-fetch-exception/index.md | 13 + .../-search-suggestion-client/-init-.md | 8 + .../-response-parser-exception/-init-.md | 5 + .../-response-parser-exception/index.md | 11 + .../get-suggestions.md | 8 + .../-search-suggestion-client/index.md | 26 ++ .../-search-suggestion-fetcher.md | 8 + .../index.md | 17 + .../-search-engine-manager/-init-.md | 9 + .../get-default-search-engine.md | 14 + .../get-search-engines.md | 9 + .../-search-engine-manager/index.md | 23 + .../-search-engine-manager/load.md | 8 + .../register-for-locale-updates.md | 9 + .../-search-engine-parser/-init-.md | 8 + .../-search-engine-parser/index.md | 19 + .../-search-engine-parser/load.md | 14 + .../-search-engine/build-search-url.md | 8 + .../-search-engine/build-suggestions-u-r-l.md | 8 + .../can-provide-search-suggestions.md | 5 + .../-search-engine/icon.md | 5 + .../-search-engine/identifier.md | 5 + .../-search-engine/index.md | 23 + .../-search-engine/name.md | 5 + .../index.md | 11 + ...-n-t-e-r-v-a-l_-m-i-l-l-i-s-e-c-o-n-d-s.md | 5 + .../-auto-save/-init-.md | 5 + .../-auto-save/-storage/index.md | 18 + .../-auto-save/-storage/save.md | 5 + .../-auto-save/index.md | 31 ++ .../-auto-save/periodically-in-foreground.md | 13 + .../-auto-save/when-going-to-background.md | 8 + .../-auto-save/when-sessions-change.md | 8 + .../-session-storage/-init-.md | 8 + .../-session-storage/auto-save.md | 8 + .../-session-storage/clear.md | 8 + .../-session-storage/index.md | 22 + .../-session-storage/restore.md | 8 + .../-session-storage/save.md | 10 + .../-snapshot-serializer/-init-.md | 8 + .../-snapshot-serializer/from-j-s-o-n.md | 5 + .../-snapshot-serializer/index.md | 20 + .../-snapshot-serializer/to-j-s-o-n.md | 5 + .../index.md | 11 + .../-init-.md | 5 + .../description.md | 5 + .../-custom-tab-action-button-config/icon.md | 5 + .../-custom-tab-action-button-config/index.md | 19 + .../pending-intent.md | 5 + .../action-button-config.md | 5 + .../-custom-tab-config/close-button-icon.md | 5 + .../-custom-tab-config/create-from-intent.md | 18 + .../disable-urlbar-hiding.md | 5 + .../-custom-tab-config/id.md | 5 + .../-custom-tab-config/index.md | 28 ++ .../is-custom-tab-intent.md | 15 + .../-custom-tab-config/menu-items.md | 5 + .../-custom-tab-config/options.md | 5 + .../show-share-menu-item.md | 5 + .../-custom-tab-config/toolbar-color.md | 5 + .../-custom-tab-menu-item/-init-.md | 5 + .../-custom-tab-menu-item/index.md | 18 + .../-custom-tab-menu-item/name.md | 5 + .../-custom-tab-menu-item/pending-intent.md | 5 + .../index.md | 11 + .../-download/-init-.md | 8 + .../-download/content-length.md | 11 + .../-download/content-type.md | 11 + .../-download/destination-directory.md | 11 + .../-download/file-name.md | 11 + .../-download/index.md | 24 ++ .../-download/url.md | 11 + .../-download/user-agent.md | 11 + .../-init-.md | 12 + .../active-session.md | 11 + .../index.md | 71 ++++ .../observe-fixed.md | 11 + .../observe-selected.md | 11 + .../on-session-selected.md | 10 + .../-selection-aware-session-observer/stop.md | 8 + .../-session-manager/-init-.md | 8 + .../-n-o_-s-e-l-e-c-t-i-o-n.md | 5 + .../-session-manager/-observer/index.md | 25 ++ .../-observer/on-all-sessions-removed.md | 11 + .../-observer/on-session-added.md | 8 + .../-observer/on-session-removed.md | 8 + .../-observer/on-session-selected.md | 8 + .../-observer/on-sessions-restored.md | 10 + .../-session-manager/-snapshot/-init-.md | 5 + .../-snapshot/-item/-init-.md | 5 + .../-snapshot/-item/engine-session-state.md | 5 + .../-snapshot/-item/engine-session.md | 5 + .../-session-manager/-snapshot/-item/index.md | 19 + .../-snapshot/-item/session.md | 5 + .../-session-manager/-snapshot/index.md | 30 ++ .../-session-manager/-snapshot/is-empty.md | 5 + .../-snapshot/selected-session-index.md | 5 + .../-session-manager/-snapshot/sessions.md | 5 + .../-session-manager/add.md | 8 + .../-session-manager/all.md | 8 + .../-session-manager/create-snapshot.md | 12 + .../-session-manager/default-session.md | 5 + .../-session-manager/engine.md | 5 + .../-session-manager/find-session-by-id.md | 9 + .../-session-manager/get-engine-session.md | 8 + .../get-or-create-engine-session.md | 8 + .../-session-manager/index.md | 60 +++ .../-session-manager/on-low-memory.md | 9 + .../-session-manager/remove-all.md | 8 + .../-session-manager/remove-sessions.md | 8 + .../-session-manager/remove.md | 8 + .../-session-manager/restore.md | 21 + .../-session-manager/select.md | 8 + .../selected-session-or-throw.md | 17 + .../-session-manager/selected-session.md | 10 + .../-session-manager/sessions.md | 8 + .../-session-manager/size.md | 8 + .../-session/-find-result/-init-.md | 8 + .../-find-result/active-match-ordinal.md | 11 + .../-session/-find-result/index.md | 21 + .../-session/-find-result/is-done-counting.md | 11 + .../-find-result/number-of-matches.md | 11 + .../-session/-init-.md | 8 + .../-session/-observer/index.md | 40 ++ .../-observer/on-app-permission-requested.md | 5 + .../-observer/on-close-window-requested.md | 5 + .../on-content-permission-requested.md | 5 + .../-observer/on-custom-tab-config-changed.md | 5 + .../-observer/on-desktop-mode-changed.md | 5 + .../-session/-observer/on-download.md | 5 + .../-session/-observer/on-find-result.md | 5 + .../-observer/on-full-screen-changed.md | 5 + .../-observer/on-loading-state-changed.md | 5 + .../-session/-observer/on-long-press.md | 5 + .../-observer/on-navigation-state-changed.md | 5 + .../-observer/on-open-window-requested.md | 5 + .../-session/-observer/on-progress.md | 5 + .../-session/-observer/on-prompt-requested.md | 5 + .../-session/-observer/on-search.md | 5 + .../-session/-observer/on-security-changed.md | 5 + .../-observer/on-thumbnail-changed.md | 5 + .../-session/-observer/on-title-changed.md | 5 + .../-session/-observer/on-tracker-blocked.md | 5 + .../on-tracker-blocking-enabled-changed.md | 5 + .../-session/-observer/on-url-changed.md | 5 + .../-session/-security-info/-init-.md | 8 + .../-session/-security-info/host.md | 11 + .../-session/-security-info/index.md | 21 + .../-session/-security-info/issuer.md | 11 + .../-session/-security-info/secure.md | 13 + .../-session/-source/-a-c-t-i-o-n_-s-e-n-d.md | 8 + .../-session/-source/-a-c-t-i-o-n_-v-i-e-w.md | 8 + .../-session/-source/-c-u-s-t-o-m_-t-a-b.md | 8 + .../-session/-source/-h-o-m-e_-s-c-r-e-e-n.md | 8 + .../-session/-source/-m-e-n-u.md | 8 + .../-session/-source/-n-e-w_-t-a-b.md | 8 + .../-session/-source/-n-o-n-e.md | 8 + .../-source/-t-e-x-t_-s-e-l-e-c-t-i-o-n.md | 8 + .../-source/-u-s-e-r_-e-n-t-e-r-e-d.md | 8 + .../-session/-source/index.md | 21 + .../-session/app-permission-request.md | 22 + .../-session/can-go-back.md | 16 + .../-session/can-go-forward.md | 16 + .../-session/close-window-request.md | 16 + .../-session/content-permission-request.md | 25 ++ .../-session/custom-tab-config.md | 16 + .../-session/desktop-mode.md | 16 + .../-session/download.md | 16 + .../-session/equals.md | 5 + .../-session/find-results.md | 16 + .../-session/full-screen-mode.md | 16 + .../-session/hash-code.md | 5 + .../-session/hit-result.md | 16 + .../-session/id.md | 5 + .../-session/index.md | 61 +++ .../-session/is-custom-tab-session.md | 8 + .../-session/loading.md | 16 + .../-session/open-window-request.md | 16 + .../-session/private.md | 5 + .../-session/progress.md | 16 + .../-session/prompt-request.md | 16 + .../-session/search-terms.md | 16 + .../-session/security-info.md | 19 + .../-session/source.md | 5 + .../-session/thumbnail.md | 16 + .../-session/title.md | 16 + .../-session/to-string.md | 5 + .../-session/tracker-blocking-enabled.md | 16 + .../-session/trackers-blocked.md | 16 + .../-session/url.md | 16 + .../index.md | 18 + .../run-with-session.md | 11 + ...o-c-o-m-p-l-e-t-e_-s-o-u-r-c-e_-n-a-m-e.md | 5 + .../-in-memory-history-storage/-init-.md | 8 + .../-in-memory-history-storage/cleanup.md | 10 + .../get-autocomplete-suggestion.md | 17 + .../get-suggestions.md | 17 + .../-in-memory-history-storage/get-visited.md | 27 ++ .../-in-memory-history-storage/index.md | 24 ++ .../record-observation.md | 15 + .../record-visit.md | 15 + .../-visit/-init-.md | 5 + .../-visit/index.md | 18 + .../-visit/timestamp.md | 5 + .../-visit/type.md | 5 + .../index.md | 16 + ...o-c-o-m-p-l-e-t-e_-s-o-u-r-c-e_-n-a-m-e.md | 5 + .../-connection/api.md | 5 + .../-connection/index.md | 13 + .../-d-b_-n-a-m-e.md | 5 + .../-places-history-storage/-init-.md | 8 + .../-places-history-storage/cleanup.md | 10 + .../get-autocomplete-suggestion.md | 17 + .../get-suggestions.md | 17 + .../-places-history-storage/get-visited.md | 27 ++ .../-places-history-storage/index.md | 25 ++ .../record-observation.md | 15 + .../-places-history-storage/record-visit.md | 15 + .../-places-history-storage/sync.md | 17 + .../-sync-auth-info.md | 5 + .../index.md | 23 + .../-browser-tabs-tray/-init-.md | 8 + .../-browser-tabs-tray/as-view.md | 10 + .../-browser-tabs-tray/index.md | 39 ++ .../on-detached-from-window.md | 5 + ...i-t-e-m_-b-a-c-k-g-r-o-u-n-d_-c-o-l-o-r.md | 5 + ...g-r-o-u-n-d_-s-e-l-e-c-t-e-d_-c-o-l-o-r.md | 5 + ...-f-a-u-l-t_-i-t-e-m_-t-e-x-t_-c-o-l-o-r.md | 5 + ...-m_-t-e-x-t_-s-e-l-e-c-t-e-d_-c-o-l-o-r.md | 5 + .../-tab-view-holder/-init-.md | 8 + .../-tab-view-holder/bind.md | 8 + .../-tab-view-holder/index.md | 46 ++ .../-tab-view-holder/on-url-changed.md | 8 + .../-tab-view-holder/unbind.md | 8 + .../-tabs-adapter/-init-.md | 8 + .../-tabs-adapter/display-sessions.md | 17 + .../-tabs-adapter/get-item-count.md | 5 + .../-tabs-adapter/index.md | 35 ++ .../-tabs-adapter/on-bind-view-holder.md | 5 + .../-tabs-adapter/on-create-view-holder.md | 5 + .../-tabs-adapter/on-session-moved.md | 10 + .../-tabs-adapter/on-sessions-changed.md | 11 + .../-tabs-adapter/on-sessions-inserted.md | 11 + .../-tabs-adapter/on-sessions-removed.md | 11 + .../-tabs-adapter/on-view-recycled.md | 5 + .../-tabs-adapter/unsubscribe-holders.md | 5 + .../-tabs-adapter/update-sessions.md | 19 + .../index.md | 20 + .../-init-.md | 13 + .../-browser-toolbar-bottom-behavior/index.md | 28 ++ .../layout-depends-on.md | 5 + .../on-nested-pre-scroll.md | 5 + .../on-start-nested-scroll.md | 5 + .../on-stop-nested-scroll.md | 5 + .../index.md | 9 + .../-edit-toolbar/-init-.md | 16 + .../-edit-toolbar/focus.md | 8 + .../-edit-toolbar/index.md | 50 +++ .../-edit-toolbar/on-layout.md | 5 + .../-edit-toolbar/on-measure.md | 5 + .../-edit-toolbar/update-url.md | 9 + .../index.md | 9 + .../-async-autocomplete-delegate/-init-.md | 9 + .../apply-autocomplete-result.md | 11 + .../coroutine-context.md | 5 + .../-async-autocomplete-delegate/index.md | 27 ++ .../no-autocomplete-result.md | 10 + .../-async-filter-listener/-init-.md | 9 + .../coroutine-context.md | 5 + .../-async-filter-listener/index.md | 26 ++ .../-async-filter-listener/invoke.md | 5 + .../-browser-toolbar/-button/-init-.md | 21 + .../-browser-toolbar/-button/index.md | 54 +++ .../-browser-toolbar/-button/padding.md | 8 + .../-browser-toolbar/-init-.md | 25 ++ .../-browser-toolbar/-toggle-button/-init-.md | 28 ++ .../-browser-toolbar/-toggle-button/index.md | 56 +++ .../-toggle-button/padding.md | 8 + .../-two-state-button/-init-.md | 24 ++ .../-two-state-button/bind.md | 8 + .../-two-state-button/enabled.md | 5 + .../-two-state-button/index.md | 48 +++ .../-browser-toolbar/add-browser-action.md | 17 + .../-browser-toolbar/add-navigation-action.md | 11 + .../-browser-toolbar/add-page-action.md | 13 + .../-browser-toolbar/browser-action-margin.md | 8 + .../-browser-toolbar/display-mode.md | 10 + .../-browser-toolbar/display-progress.md | 10 + .../display-site-security-icon.md | 8 + .../-browser-toolbar/edit-mode.md | 10 + .../-browser-toolbar/hint-color.md | 8 + .../-browser-toolbar/hint.md | 8 + .../-browser-toolbar/index.md | 104 +++++ .../-browser-toolbar/invalidate-actions.md | 13 + .../-browser-toolbar/menu-view-color.md | 5 + .../-browser-toolbar/on-back-pressed.md | 13 + .../-browser-toolbar/on-layout.md | 5 + .../-browser-toolbar/on-measure.md | 5 + .../-browser-toolbar/on-url-clicked.md | 10 + .../set-autocomplete-listener.md | 13 + .../-browser-toolbar/set-menu-builder.md | 9 + .../set-on-edit-focus-change-listener.md | 8 + .../-browser-toolbar/set-on-edit-listener.md | 10 + .../set-on-url-commit-listener.md | 14 + .../-browser-toolbar/set-search-terms.md | 13 + .../-browser-toolbar/set-url-text-padding.md | 8 + .../-browser-toolbar/site-secure.md | 10 + .../-browser-toolbar/site-security-color.md | 9 + .../-browser-toolbar/text-color.md | 8 + .../-browser-toolbar/text-size.md | 8 + .../-browser-toolbar/typeface.md | 8 + .../-browser-toolbar/url-box-margin.md | 8 + .../-browser-toolbar/url-box-view.md | 8 + .../-browser-toolbar/url.md | 10 + .../index.md | 11 + .../-suggestion-provider/index.md | 31 ++ .../on-input-cancelled.md | 8 + .../-suggestion-provider/on-input-changed.md | 22 + .../-suggestion-provider/on-input-started.md | 8 + .../should-clear-suggestions.md | 10 + .../-awesome-bar/-suggestion/-chip/-init-.md | 9 + .../-awesome-bar/-suggestion/-chip/index.md | 20 + .../-awesome-bar/-suggestion/-chip/title.md | 5 + .../-suggestion/-flag/-b-o-o-k-m-a-r-k.md | 5 + .../-suggestion/-flag/-c-l-i-p-b-o-a-r-d.md | 5 + .../-suggestion/-flag/-o-p-e-n_-t-a-b.md | 5 + .../-awesome-bar/-suggestion/-flag/index.md | 17 + .../-awesome-bar/-suggestion/-init-.md | 8 + .../-suggestion/are-contents-the-same.md | 11 + .../-awesome-bar/-suggestion/chips.md | 11 + .../-awesome-bar/-suggestion/description.md | 11 + .../-awesome-bar/-suggestion/flags.md | 11 + .../-awesome-bar/-suggestion/icon.md | 13 + .../-awesome-bar/-suggestion/id.md | 15 + .../-awesome-bar/-suggestion/index.md | 40 ++ .../-suggestion/on-chip-clicked.md | 11 + .../-suggestion/on-suggestion-clicked.md | 11 + .../-awesome-bar/-suggestion/score.md | 13 + .../-awesome-bar/-suggestion/title.md | 11 + .../-awesome-bar/add-providers.md | 8 + .../-awesome-bar/as-view.md | 8 + .../-awesome-bar/index.md | 37 ++ .../-awesome-bar/on-input-cancelled.md | 8 + .../-awesome-bar/on-input-changed.md | 11 + .../-awesome-bar/on-input-started.md | 8 + .../-awesome-bar/set-on-stop-listener.md | 9 + .../index.md | 9 + .../-history-tracking-delegate/get-visited.md | 12 + .../-history-tracking-delegate/index.md | 25 ++ .../on-title-changed.md | 8 + .../-history-tracking-delegate/on-visited.md | 8 + .../index.md | 9 + .../contains-video-and-audio-sources.md | 5 + .../-permission-request/grant-if.md | 16 + .../-permission-request/grant.md | 12 + .../-permission-request/index.md | 31 ++ .../-permission-request/permissions.md | 8 + .../-permission-request/reject.md | 8 + .../-permission-request/uri.md | 8 + .../-permission/-app-audio/-init-.md | 5 + .../-permission/-app-audio/desc.md | 13 + .../-permission/-app-audio/id.md | 13 + .../-permission/-app-audio/index.md | 18 + .../-permission/-app-camera/-init-.md | 5 + .../-permission/-app-camera/desc.md | 13 + .../-permission/-app-camera/id.md | 13 + .../-permission/-app-camera/index.md | 18 + .../-app-location-coarse/-init-.md | 5 + .../-permission/-app-location-coarse/desc.md | 13 + .../-permission/-app-location-coarse/id.md | 13 + .../-permission/-app-location-coarse/index.md | 18 + .../-permission/-app-location-fine/-init-.md | 5 + .../-permission/-app-location-fine/desc.md | 13 + .../-permission/-app-location-fine/id.md | 13 + .../-permission/-app-location-fine/index.md | 18 + .../-content-audio-capture/-init-.md | 5 + .../-content-audio-capture/desc.md | 13 + .../-permission/-content-audio-capture/id.md | 13 + .../-content-audio-capture/index.md | 18 + .../-content-audio-microphone/-init-.md | 5 + .../-content-audio-microphone/desc.md | 13 + .../-content-audio-microphone/id.md | 13 + .../-content-audio-microphone/index.md | 18 + .../-content-audio-other/-init-.md | 5 + .../-permission/-content-audio-other/desc.md | 13 + .../-permission/-content-audio-other/id.md | 13 + .../-permission/-content-audio-other/index.md | 18 + .../-content-autoplay-media/-init-.md | 5 + .../-content-autoplay-media/desc.md | 13 + .../-permission/-content-autoplay-media/id.md | 13 + .../-content-autoplay-media/index.md | 18 + .../-content-geo-location/-init-.md | 5 + .../-permission/-content-geo-location/desc.md | 13 + .../-permission/-content-geo-location/id.md | 13 + .../-content-geo-location/index.md | 18 + .../-content-notification/-init-.md | 5 + .../-permission/-content-notification/desc.md | 13 + .../-permission/-content-notification/id.md | 13 + .../-content-notification/index.md | 18 + .../-content-protected-media-id/-init-.md | 5 + .../-content-protected-media-id/desc.md | 13 + .../-content-protected-media-id/id.md | 13 + .../-content-protected-media-id/index.md | 18 + .../-content-video-application/-init-.md | 5 + .../-content-video-application/desc.md | 13 + .../-content-video-application/id.md | 13 + .../-content-video-application/index.md | 18 + .../-content-video-browser/-init-.md | 5 + .../-content-video-browser/desc.md | 13 + .../-permission/-content-video-browser/id.md | 13 + .../-content-video-browser/index.md | 18 + .../-content-video-camera/-init-.md | 5 + .../-permission/-content-video-camera/desc.md | 13 + .../-permission/-content-video-camera/id.md | 13 + .../-content-video-camera/index.md | 18 + .../-content-video-capture/-init-.md | 5 + .../-content-video-capture/desc.md | 13 + .../-permission/-content-video-capture/id.md | 13 + .../-content-video-capture/index.md | 18 + .../-content-video-other/-init-.md | 5 + .../-permission/-content-video-other/desc.md | 13 + .../-permission/-content-video-other/id.md | 13 + .../-permission/-content-video-other/index.md | 18 + .../-content-video-screen/-init-.md | 5 + .../-permission/-content-video-screen/desc.md | 13 + .../-permission/-content-video-screen/id.md | 13 + .../-content-video-screen/index.md | 18 + .../-content-video-window/-init-.md | 5 + .../-permission/-content-video-window/desc.md | 13 + .../-permission/-content-video-window/id.md | 13 + .../-content-video-window/index.md | 18 + .../-permission/-generic/-init-.md | 5 + .../-permission/-generic/desc.md | 13 + .../-permission/-generic/id.md | 13 + .../-permission/-generic/index.md | 18 + .../-permission/desc.md | 11 + .../-permission/id.md | 11 + .../-permission/index.md | 62 +++ .../index.md | 10 + .../-c-r-e-a-t-o-r/create-from-parcel.md | 5 + .../-choice/-c-r-e-a-t-o-r/index.md | 12 + .../-choice/-c-r-e-a-t-o-r/new-array.md | 5 + .../-choice/-init-.md | 8 + .../-choice/children.md | 11 + .../-choice/create-from-parcel.md | 5 + .../-choice/describe-contents.md | 5 + .../-choice/enable.md | 11 + .../-choice/id.md | 11 + .../-choice/index.md | 45 ++ .../-choice/is-a-separator.md | 11 + .../-choice/is-group-type.md | 5 + .../-choice/label.md | 11 + .../-choice/new-array.md | 5 + .../-choice/selected.md | 11 + .../-choice/write-to-parcel.md | 5 + .../-prompt-request/-alert/-init-.md | 8 + .../-alert/has-shown-many-dialogs.md | 11 + .../-prompt-request/-alert/index.md | 23 + .../-prompt-request/-alert/message.md | 11 + .../-prompt-request/-alert/on-confirm.md | 11 + .../-prompt-request/-alert/on-dismiss.md | 11 + .../-prompt-request/-alert/title.md | 11 + .../-prompt-request/-authentication/-init-.md | 10 + .../-authentication/-level/-n-o-n-e.md | 5 + .../-p-a-s-s-w-o-r-d_-e-n-c-r-y-p-t-e-d.md | 5 + .../-authentication/-level/-s-e-c-u-r-e-d.md | 5 + .../-authentication/-level/index.md | 13 + .../-authentication/-method/-h-o-s-t.md | 5 + .../-authentication/-method/-p-r-o-x-y.md | 5 + .../-authentication/-method/index.md | 12 + .../-prompt-request/-authentication/index.md | 38 ++ .../-authentication/is-cross-origin.md | 11 + .../-prompt-request/-authentication/level.md | 13 + .../-authentication/message.md | 11 + .../-prompt-request/-authentication/method.md | 11 + .../-authentication/on-confirm.md | 11 + .../-authentication/on-dismiss.md | 11 + .../-authentication/only-show-password.md | 11 + .../-authentication/password.md | 11 + .../-authentication/previous-failed.md | 11 + .../-prompt-request/-authentication/title.md | 11 + .../-authentication/user-name.md | 11 + .../-prompt-request/-color/-init-.md | 8 + .../-prompt-request/-color/default-color.md | 11 + .../-prompt-request/-color/index.md | 21 + .../-prompt-request/-color/on-confirm.md | 11 + .../-prompt-request/-color/on-dismiss.md | 11 + .../-prompt-request/-confirm/-init-.md | 11 + .../-confirm/has-shown-many-dialogs.md | 11 + .../-prompt-request/-confirm/index.md | 31 ++ .../-prompt-request/-confirm/message.md | 11 + .../-confirm/negative-button-title.md | 11 + .../-confirm/neutral-button-title.md | 11 + .../-confirm/on-confirm-negative-button.md | 11 + .../-confirm/on-confirm-neutral-button.md | 11 + .../-confirm/on-confirm-positive-button.md | 11 + .../-prompt-request/-confirm/on-dismiss.md | 11 + .../-confirm/positive-button-title.md | 11 + .../-prompt-request/-confirm/title.md | 11 + .../-prompt-request/-file/-init-.md | 8 + .../-prompt-request/-file/index.md | 23 + .../-file/is-multiple-files-selection.md | 11 + .../-prompt-request/-file/mime-types.md | 11 + .../-prompt-request/-file/on-dismiss.md | 11 + .../-file/on-multiple-files-selected.md | 11 + .../-file/on-single-file-selected.md | 11 + .../-prompt-request/-menu-choice/-init-.md | 8 + .../-prompt-request/-menu-choice/choices.md | 11 + .../-prompt-request/-menu-choice/index.md | 20 + .../-menu-choice/on-confirm.md | 11 + .../-multiple-choice/-init-.md | 8 + .../-multiple-choice/choices.md | 11 + .../-prompt-request/-multiple-choice/index.md | 20 + .../-multiple-choice/on-confirm.md | 11 + .../-prompt-request/-popup/-init-.md | 10 + .../-prompt-request/-popup/index.md | 23 + .../-prompt-request/-popup/on-allow.md | 11 + .../-prompt-request/-popup/on-deny.md | 11 + .../-prompt-request/-popup/target-uri.md | 11 + .../-prompt-request/-single-choice/-init-.md | 8 + .../-prompt-request/-single-choice/choices.md | 11 + .../-prompt-request/-single-choice/index.md | 20 + .../-single-choice/on-confirm.md | 11 + .../-prompt-request/-text-prompt/-init-.md | 8 + .../-text-prompt/has-shown-many-dialogs.md | 11 + .../-prompt-request/-text-prompt/index.md | 24 ++ .../-text-prompt/input-label.md | 11 + .../-text-prompt/input-value.md | 11 + .../-text-prompt/on-confirm.md | 11 + .../-text-prompt/on-dismiss.md | 11 + .../-prompt-request/-text-prompt/title.md | 11 + .../-prompt-request/-time-selection/-init-.md | 8 + .../-time-selection/-type/-d-a-t-e.md | 5 + .../-type/-d-a-t-e_-a-n-d_-t-i-m-e.md | 5 + .../-time-selection/-type/-t-i-m-e.md | 5 + .../-time-selection/-type/index.md | 13 + .../-prompt-request/-time-selection/index.md | 31 ++ .../-time-selection/initial-date.md | 11 + .../-time-selection/maximum-date.md | 11 + .../-time-selection/minimum-date.md | 11 + .../-time-selection/on-clear.md | 11 + .../-time-selection/on-confirm.md | 11 + .../-prompt-request/-time-selection/title.md | 11 + .../-prompt-request/-time-selection/type.md | 11 + .../-prompt-request/index.md | 39 ++ .../index.md | 10 + .../-error-response/-init-.md | 8 + .../-error-response/data.md | 5 + .../-error-response/encoding.md | 5 + .../-error-response/index.md | 22 + .../-error-response/mime-type.md | 5 + .../-error-response/url.md | 5 + .../-interception-response/-content/-init-.md | 5 + .../-interception-response/-content/data.md | 5 + .../-content/encoding.md | 5 + .../-interception-response/-content/index.md | 19 + .../-content/mime-type.md | 5 + .../-interception-response/-url/-init-.md | 5 + .../-interception-response/-url/index.md | 17 + .../-interception-response/-url/url.md | 5 + .../-interception-response/index.md | 21 + .../-request-interceptor/index.md | 21 + .../-request-interceptor/on-error-request.md | 21 + .../-request-interceptor/on-load-request.md | 18 + .../index.md | 9 + .../-window-request/index.md | 26 ++ .../-window-request/prepare.md | 12 + .../-window-request/start.md | 8 + .../-window-request/url.md | 10 + .../index.md | 9 + .../-default-settings/-init-.md | 8 + .../-default-settings/allow-content-access.md | 11 + .../allow-file-access-from-file-u-r-ls.md | 11 + .../-default-settings/allow-file-access.md | 10 + ...allow-universal-access-from-file-u-r-ls.md | 11 + .../display-zoom-controls.md | 10 + .../-default-settings/dom-storage-enabled.md | 10 + .../history-tracking-delegate.md | 10 + .../horizontal-scroll-bar-enabled.md | 10 + .../-default-settings/index.md | 38 ++ ...a-script-can-open-windows-automatically.md | 10 + .../-default-settings/javascript-enabled.md | 10 + .../load-with-overview-mode.md | 10 + .../media-playback-requires-user-gesture.md | 10 + .../remote-debugging-enabled.md | 10 + .../-default-settings/request-interceptor.md | 10 + .../support-multiple-windows.md | 10 + .../-default-settings/testing-mode-enabled.md | 10 + .../tracking-protection-policy.md | 10 + .../-default-settings/user-agent-string.md | 10 + .../vertical-scroll-bar-enabled.md | 10 + .../-default-settings/web-fonts-enabled.md | 10 + .../-engine-session-state/index.md | 23 + .../-engine-session-state/to-j-s-o-n.md | 11 + .../-engine-session/-init-.md | 10 + .../-engine-session/-observer/index.md | 33 ++ .../-observer/on-app-permission-request.md | 5 + .../on-cancel-content-permission-request.md | 5 + .../-observer/on-close-window-request.md | 5 + .../on-content-permission-request.md | 5 + .../-observer/on-desktop-mode-change.md | 5 + .../-observer/on-external-resource.md | 5 + .../-observer/on-find-result.md | 5 + .../-engine-session/-observer/on-find.md | 5 + .../-observer/on-full-screen-change.md | 5 + .../-observer/on-loading-state-change.md | 5 + .../-observer/on-location-change.md | 5 + .../-observer/on-long-press.md | 5 + .../-observer/on-navigation-state-change.md | 5 + .../-observer/on-open-window-request.md | 5 + .../-engine-session/-observer/on-progress.md | 5 + .../-observer/on-prompt-request.md | 5 + .../-observer/on-security-change.md | 5 + .../-observer/on-thumbnail-change.md | 5 + .../-observer/on-title-change.md | 5 + .../-observer/on-tracker-blocked.md | 5 + .../on-tracker-blocking-enabled-change.md | 5 + .../for-private-sessions-only.md | 8 + .../for-regular-sessions-only.md | 8 + .../index.md | 31 ++ .../-tracking-protection-policy/-a-d.md | 5 + .../-a-n-a-l-y-t-i-c-s.md | 5 + .../-c-o-n-t-e-n-t.md | 5 + .../-s-o-c-i-a-l.md | 5 + .../-tracking-protection-policy/-t-e-s-t.md | 5 + .../-tracking-protection-policy/all.md | 5 + .../-tracking-protection-policy/categories.md | 5 + .../-tracking-protection-policy/contains.md | 5 + .../-tracking-protection-policy/equals.md | 5 + .../-tracking-protection-policy/hash-code.md | 5 + .../-tracking-protection-policy/index.md | 50 +++ .../-tracking-protection-policy/none.md | 5 + .../-tracking-protection-policy/select.md | 5 + .../use-for-private-sessions.md | 5 + .../use-for-regular-sessions.md | 5 + .../-engine-session/capture-thumbnail.md | 8 + .../-engine-session/clear-data.md | 8 + .../-engine-session/clear-find-matches.md | 8 + .../-engine-session/close.md | 9 + .../disable-tracking-protection.md | 8 + .../enable-tracking-protection.md | 11 + .../-engine-session/exit-full-screen-mode.md | 8 + .../-engine-session/find-all.md | 11 + .../-engine-session/find-next.md | 12 + .../-engine-session/go-back.md | 8 + .../-engine-session/go-forward.md | 8 + .../-engine-session/index.md | 60 +++ .../-engine-session/load-data.md | 27 ++ .../-engine-session/load-url.md | 8 + .../-engine-session/reload.md | 8 + .../-engine-session/restore-state.md | 11 + .../-engine-session/save-state.md | 13 + .../-engine-session/settings.md | 8 + .../-engine-session/stop-loading.md | 8 + .../-engine-session/toggle-desktop-mode.md | 8 + .../-engine-view/as-view.md | 8 + .../can-scroll-vertically-down.md | 9 + .../-engine-view/index.md | 29 ++ .../-engine-view/on-create.md | 9 + .../-engine-view/on-destroy.md | 9 + .../-engine-view/on-pause.md | 9 + .../-engine-view/on-resume.md | 9 + .../-engine-view/on-start.md | 9 + .../-engine-view/on-stop.md | 9 + .../-engine-view/render.md | 8 + .../-engine/create-session-state.md | 8 + .../-engine/create-session.md | 15 + .../-engine/create-view.md | 17 + .../-engine/index.md | 31 ++ .../-engine/name.md | 13 + .../-engine/settings.md | 8 + .../-engine/speculative-connect.md | 13 + .../-hit-result/-a-u-d-i-o/-init-.md | 8 + .../-hit-result/-a-u-d-i-o/index.md | 19 + .../-hit-result/-a-u-d-i-o/src.md | 8 + .../-hit-result/-e-m-a-i-l/-init-.md | 8 + .../-hit-result/-e-m-a-i-l/index.md | 19 + .../-hit-result/-e-m-a-i-l/src.md | 8 + .../-hit-result/-g-e-o/-init-.md | 8 + .../-hit-result/-g-e-o/index.md | 19 + .../-hit-result/-g-e-o/src.md | 8 + .../-hit-result/-i-m-a-g-e/-init-.md | 8 + .../-hit-result/-i-m-a-g-e/index.md | 19 + .../-hit-result/-i-m-a-g-e/src.md | 8 + .../-hit-result/-i-m-a-g-e_-s-r-c/-init-.md | 8 + .../-hit-result/-i-m-a-g-e_-s-r-c/index.md | 20 + .../-hit-result/-i-m-a-g-e_-s-r-c/src.md | 8 + .../-hit-result/-i-m-a-g-e_-s-r-c/uri.md | 5 + .../-hit-result/-p-h-o-n-e/-init-.md | 8 + .../-hit-result/-p-h-o-n-e/index.md | 19 + .../-hit-result/-p-h-o-n-e/src.md | 8 + .../-hit-result/-u-n-k-n-o-w-n/-init-.md | 8 + .../-hit-result/-u-n-k-n-o-w-n/index.md | 19 + .../-hit-result/-u-n-k-n-o-w-n/src.md | 8 + .../-hit-result/-v-i-d-e-o/-init-.md | 8 + .../-hit-result/-v-i-d-e-o/index.md | 19 + .../-hit-result/-v-i-d-e-o/src.md | 8 + .../-hit-result/index.md | 40 ++ .../-hit-result/src.md | 5 + .../-lifecycle-observer/-init-.md | 8 + .../-lifecycle-observer/engine-view.md | 5 + .../-lifecycle-observer/index.md | 30 ++ .../-lifecycle-observer/on-create.md | 5 + .../-lifecycle-observer/on-destroy.md | 5 + .../-lifecycle-observer/on-pause.md | 5 + .../-lifecycle-observer/on-resume.md | 5 + .../-lifecycle-observer/on-start.md | 5 + .../-lifecycle-observer/on-stop.md | 5 + .../-settings/-init-.md | 10 + .../-settings/allow-content-access.md | 19 + .../allow-file-access-from-file-u-r-ls.md | 19 + .../-settings/allow-file-access.md | 16 + ...allow-universal-access-from-file-u-r-ls.md | 19 + .../-settings/display-zoom-controls.md | 16 + .../-settings/dom-storage-enabled.md | 16 + .../-settings/history-tracking-delegate.md | 16 + .../horizontal-scroll-bar-enabled.md | 16 + .../-settings/index.md | 46 ++ ...a-script-can-open-windows-automatically.md | 16 + .../-settings/javascript-enabled.md | 16 + .../-settings/load-with-overview-mode.md | 16 + .../media-playback-requires-user-gesture.md | 16 + .../-settings/remote-debugging-enabled.md | 16 + .../-settings/request-interceptor.md | 16 + .../-settings/support-multiple-windows.md | 16 + .../-settings/testing-mode-enabled.md | 16 + .../-settings/tracking-protection-policy.md | 16 + .../-settings/user-agent-string.md | 16 + .../-settings/vertical-scroll-bar-enabled.md | 16 + .../-settings/web-fonts-enabled.md | 16 + .../-unsupported-setting-exception/-init-.md | 8 + .../-unsupported-setting-exception/index.md | 13 + .../-unsupported-setting/-init-.md | 5 + .../-unsupported-setting/get-value.md | 5 + .../-unsupported-setting/index.md | 18 + .../-unsupported-setting/set-value.md | 5 + .../index.md | 23 + .../-client/-init-.md | 13 + .../-client/default-headers.md | 8 + .../-client/fetch.md | 33 ++ .../-client/index.md | 38 ++ .../-header/-init-.md | 8 + .../-header/index.md | 20 + .../-header/name.md | 5 + .../-header/value.md | 5 + .../-headers/contains.md | 8 + .../-headers/get-all.md | 8 + .../-headers/get.md | 12 + .../-headers/index.md | 28 ++ .../-headers/set.md | 8 + .../-headers/size.md | 8 + .../-mutable-headers/-init-.md | 8 + .../-mutable-headers/append.md | 8 + .../-mutable-headers/contains.md | 10 + .../-mutable-headers/get-all.md | 10 + .../-mutable-headers/get.md | 16 + .../-mutable-headers/index.md | 30 ++ .../-mutable-headers/iterator.md | 8 + .../-mutable-headers/set.md | 14 + .../-mutable-headers/size.md | 10 + .../-request/-body/-init-.md | 11 + .../-request/-body/close.md | 8 + .../-request/-body/from-file.md | 8 + .../-request/-body/from-string.md | 8 + .../-request/-body/index.md | 31 ++ .../-request/-body/use-stream.md | 9 + .../-request/-init-.md | 11 + .../-request/-method/-c-o-n-n-e-c-t.md | 5 + .../-request/-method/-d-e-l-e-t-e.md | 5 + .../-request/-method/-g-e-t.md | 5 + .../-request/-method/-h-e-a-d.md | 5 + .../-request/-method/-o-p-t-i-o-n-s.md | 5 + .../-request/-method/-p-o-s-t.md | 5 + .../-request/-method/-p-u-t.md | 5 + .../-request/-method/-t-r-a-c-e.md | 5 + .../-request/-method/index.md | 26 ++ .../-request/-redirect/-f-o-l-l-o-w.md | 8 + .../-request/-redirect/-m-a-n-u-a-l.md | 8 + .../-request/-redirect/index.md | 12 + .../-request/body.md | 11 + .../-request/connect-timeout.md | 15 + .../-request/headers.md | 11 + .../-request/index.md | 36 ++ .../-request/method.md | 11 + .../-request/read-timeout.md | 15 + .../-request/redirect.md | 11 + .../-request/url.md | 11 + .../-response/-body/-init-.md | 10 + .../-response/-body/close.md | 8 + .../-response/-body/empty.md | 8 + .../-response/-body/index.md | 30 ++ .../-response/-body/string.md | 10 + .../-response/-body/use-buffered-reader.md | 11 + .../-response/-body/use-stream.md | 11 + .../-response/-init-.md | 22 + .../-response/body.md | 5 + .../-response/close.md | 8 + .../-response/headers.md | 5 + .../-response/index.md | 55 +++ .../-response/status.md | 5 + .../-response/url.md | 5 + .../client-error.md | 8 + .../mozilla.components.concept.fetch/index.md | 21 + .../success.md | 8 + .../-history-autocomplete-result/-init-.md | 8 + .../-history-autocomplete-result/index.md | 23 + .../-history-autocomplete-result/input.md | 11 + .../-history-autocomplete-result/source.md | 11 + .../-history-autocomplete-result/text.md | 11 + .../total-items.md | 11 + .../-history-autocomplete-result/url.md | 11 + .../-history-storage/cleanup.md | 8 + .../get-autocomplete-suggestion.md | 15 + .../-history-storage/get-suggestions.md | 15 + .../-history-storage/get-visited.md | 23 + .../-history-storage/index.md | 25 ++ .../-history-storage/record-observation.md | 13 + .../-history-storage/record-visit.md | 13 + .../-page-observation/-init-.md | 5 + .../-page-observation/index.md | 17 + .../-page-observation/title.md | 5 + .../-search-result/-init-.md | 8 + .../-search-result/id.md | 11 + .../-search-result/index.md | 22 + .../-search-result/score.md | 13 + .../-search-result/title.md | 11 + .../-search-result/url.md | 11 + .../-sync-error/-init-.md | 5 + .../-sync-error/exception.md | 5 + .../-sync-error/index.md | 17 + .../-sync-ok.md | 5 + .../-sync-status.md | 12 + .../-syncable-store/index.md | 20 + .../-syncable-store/sync.md | 15 + .../-visit-type/-l-i-n-k.md | 11 + .../-visit-type/-r-e-l-o-a-d.md | 11 + .../-visit-type/-t-y-p-e-d.md | 11 + .../-visit-type/index.md | 21 + .../-visit-type/type.md | 5 + .../index.md | 17 + .../-tabs-tray/-observer/index.md | 20 + .../-tabs-tray/-observer/on-tab-closed.md | 8 + .../-tabs-tray/-observer/on-tab-selected.md | 8 + .../-tabs-tray/as-view.md | 8 + .../-tabs-tray/display-sessions.md | 15 + .../-tabs-tray/index.md | 44 ++ .../-tabs-tray/on-session-moved.md | 8 + .../-tabs-tray/on-sessions-changed.md | 9 + .../-tabs-tray/on-sessions-inserted.md | 9 + .../-tabs-tray/on-sessions-removed.md | 9 + .../-tabs-tray/update-sessions.md | 17 + .../index.md | 9 + .../apply-autocomplete-result.md | 9 + .../-autocomplete-delegate/index.md | 21 + .../no-autocomplete-result.md | 8 + .../-autocomplete-result/-init-.md | 8 + .../-autocomplete-result/index.md | 23 + .../-autocomplete-result/input.md | 11 + .../-autocomplete-result/source.md | 11 + .../-autocomplete-result/text.md | 11 + .../-autocomplete-result/total-items.md | 11 + .../-autocomplete-result/url.md | 11 + .../-toolbar/-action-button/-init-.md | 19 + .../-toolbar/-action-button/bind.md | 8 + .../-action-button/content-description.md | 8 + .../-toolbar/-action-button/create-view.md | 8 + .../-toolbar/-action-button/image-drawable.md | 8 + .../-toolbar/-action-button/index.md | 46 ++ .../-toolbar/-action-button/visible.md | 10 + .../-toolbar/-action-image/-init-.md | 17 + .../-toolbar/-action-image/bind.md | 8 + .../-toolbar/-action-image/create-view.md | 8 + .../-toolbar/-action-image/index.md | 36 ++ .../-toolbar/-action-space/-init-.md | 13 + .../-toolbar/-action-space/bind.md | 8 + .../-toolbar/-action-space/create-view.md | 8 + .../-toolbar/-action-space/index.md | 32 ++ .../-toolbar/-action-toggle-button/-init-.md | 26 ++ .../-toolbar/-action-toggle-button/bind.md | 8 + .../-action-toggle-button/create-view.md | 8 + .../-toolbar/-action-toggle-button/index.md | 54 +++ .../-action-toggle-button/is-selected.md | 8 + .../-action-toggle-button/set-selected.md | 13 + .../-toolbar/-action-toggle-button/toggle.md | 11 + .../-toolbar/-action-toggle-button/visible.md | 10 + .../-toolbar/-action/bind.md | 5 + .../-toolbar/-action/create-view.md | 5 + .../-toolbar/-action/index.md | 30 ++ .../-toolbar/-action/visible.md | 5 + .../-toolbar/-on-edit-listener/index.md | 15 + .../-on-edit-listener/on-start-editing.md | 8 + .../-on-edit-listener/on-stop-editing.md | 8 + .../-on-edit-listener/on-text-changed.md | 8 + .../-site-security/-i-n-s-e-c-u-r-e.md | 5 + .../-toolbar/-site-security/-s-e-c-u-r-e.md | 5 + .../-toolbar/-site-security/index.md | 12 + .../-toolbar/add-browser-action.md | 11 + .../-toolbar/add-navigation-action.md | 8 + .../-toolbar/add-page-action.md | 11 + .../-toolbar/as-view.md | 8 + .../-toolbar/display-mode.md | 8 + .../-toolbar/display-progress.md | 8 + .../-toolbar/edit-mode.md | 8 + .../-toolbar/index.md | 49 +++ .../-toolbar/on-back-pressed.md | 11 + .../-toolbar/set-autocomplete-listener.md | 11 + .../-toolbar/set-on-edit-listener.md | 8 + .../-toolbar/set-on-url-commit-listener.md | 12 + .../-toolbar/set-search-terms.md | 11 + .../-toolbar/site-secure.md | 8 + .../-toolbar/url.md | 8 + .../index.md | 11 + .../-firefox-accounts-auth-feature/-init-.md | 9 + .../begin-authentication.md | 5 + .../-firefox-accounts-auth-feature/index.md | 26 ++ .../interceptor.md | 5 + .../index.md | 9 + .../-clipboard-suggestion-provider/-init-.md | 9 + .../-clipboard-suggestion-provider/index.md | 33 ++ .../on-input-changed.md | 24 ++ .../-init-.md | 9 + .../index.md | 33 ++ .../on-input-changed.md | 24 ++ .../-search-suggestion-provider/-init-.md | 9 + ...-m-u-l-t-i-p-l-e_-s-u-g-g-e-s-t-i-o-n-s.md | 5 + .../-s-i-n-g-l-e_-s-u-g-g-e-s-t-i-o-n.md | 5 + .../-mode/index.md | 12 + .../-search-suggestion-provider/index.md | 39 ++ .../on-input-changed.md | 24 ++ .../should-clear-suggestions.md | 12 + .../-session-suggestion-provider/-init-.md | 9 + .../-session-suggestion-provider/index.md | 33 ++ .../on-input-changed.md | 24 ++ .../index.md | 12 + .../-awesome-bar-feature/-init-.md | 8 + .../add-clipboard-provider.md | 5 + .../add-history-provider.md | 8 + .../add-search-provider.md | 8 + .../add-session-provider.md | 8 + .../-awesome-bar-feature/index.md | 22 + .../index.md | 9 + .../-context-menu-candidate/-init-.md | 8 + .../-context-menu-candidate/action.md | 11 + .../create-copy-image-location-candidate.md | 8 + .../create-copy-link-candidate.md | 8 + .../create-open-image-in-new-tab-candidate.md | 8 + .../create-open-in-new-tab-candidate.md | 8 + .../create-open-in-private-tab-candidate.md | 8 + .../create-save-image-candidate.md | 8 + .../create-share-link-candidate.md | 8 + .../default-candidates.md | 10 + .../-context-menu-candidate/id.md | 11 + .../-context-menu-candidate/index.md | 35 ++ .../-context-menu-candidate/label.md | 11 + .../-context-menu-candidate/show-for.md | 13 + .../-context-menu-feature/-init-.md | 12 + .../-context-menu-feature/index.md | 24 ++ .../-context-menu-feature/start.md | 10 + .../-context-menu-feature/stop.md | 10 + .../-context-menu-fragment/-init-.md | 8 + .../-context-menu-fragment/create.md | 8 + .../-context-menu-fragment/index.md | 25 ++ .../on-create-dialog.md | 5 + .../index.md | 11 + .../-abstract-custom-tabs-service/-init-.md | 8 + .../-abstract-custom-tabs-service/engine.md | 5 + .../extra-command.md | 5 + .../-abstract-custom-tabs-service/index.md | 47 +++ .../may-launch-url.md | 5 + .../new-session.md | 5 + .../post-message.md | 5 + .../request-post-message-channel.md | 5 + .../update-visuals.md | 5 + .../validate-relationship.md | 5 + .../-abstract-custom-tabs-service/warmup.md | 5 + .../-custom-tabs-toolbar-feature/-init-.md | 8 + .../-custom-tabs-toolbar-feature/index.md | 21 + .../on-back-pressed.md | 11 + .../-custom-tabs-toolbar-feature/start.md | 8 + .../-custom-tabs-toolbar-feature/stop.md | 8 + .../index.md | 10 + .../-android-download-manager.md | 5 + .../-f-r-a-g-m-e-n-t_-t-a-g.md | 5 + .../-download-dialog-fragment/-init-.md | 11 + .../-k-e-y_-c-o-n-t-e-n-t_-l-e-n-g-t-h.md | 8 + .../-k-e-y_-f-i-l-e_-n-a-m-e.md | 8 + .../-k-e-y_-u-r-l.md | 8 + .../-download-dialog-fragment/index.md | 43 ++ .../on-start-download.md | 10 + .../-download-dialog-fragment/set-download.md | 8 + .../-download-manager/-init-.md | 8 + .../-download-manager/download.md | 19 + .../-download-manager/index.md | 26 ++ .../on-download-completed.md | 11 + .../-download-manager/unregister-listener.md | 8 + .../-downloads-feature/-init-.md | 10 + .../-downloads-feature/index.md | 45 ++ .../on-download-completed.md | 11 + .../-downloads-feature/on-download.md | 10 + .../on-need-to-request-permissions.md | 15 + .../on-permissions-result.md | 9 + .../-downloads-feature/start.md | 11 + .../-downloads-feature/stop.md | 12 + .../-on-download-completed.md | 5 + .../-on-need-to-request-permissions.md | 5 + .../-init-.md | 13 + .../-k-e-y_-c-a-n-c-e-l-a-b-l-e.md | 5 + .../-k-e-y_-n-e-g-a-t-i-v-e_-t-e-x-t.md | 5 + .../-k-e-y_-p-o-s-i-t-i-v-e_-t-e-x-t.md | 5 + .../-k-e-y_-t-h-e-m-e_-i-d.md | 5 + .../-k-e-y_-t-i-t-l-e_-t-e-x-t.md | 5 + .../-simple-download-dialog-fragment/index.md | 52 +++ .../new-instance.md | 8 + .../on-create-dialog.md | 5 + .../index.md | 20 + .../-find-in-page-bar/-init-.md | 8 + .../-find-in-page-bar/clear.md | 10 + .../-find-in-page-bar/display-result.md | 10 + .../-find-in-page-bar/focus.md | 10 + .../-find-in-page-bar/index.md | 52 +++ .../-find-in-page-bar/listener.md | 10 + .../-find-in-page-view/-listener/index.md | 15 + .../-listener/on-clear-matches.md | 5 + .../-find-in-page-view/-listener/on-close.md | 5 + .../-listener/on-find-all.md | 5 + .../-listener/on-next-result.md | 5 + .../-listener/on-previous-result.md | 5 + .../-find-in-page-view/as-view.md | 8 + .../-find-in-page-view/clear.md | 8 + .../-find-in-page-view/display-result.md | 8 + .../-find-in-page-view/focus.md | 8 + .../-find-in-page-view/index.md | 34 ++ .../-find-in-page-view/listener.md | 8 + .../index.md | 10 + .../-find-in-page-feature/-init-.md | 8 + .../-find-in-page-feature/bind.md | 9 + .../-find-in-page-feature/index.md | 23 + .../-find-in-page-feature/on-back-pressed.md | 10 + .../-find-in-page-feature/start.md | 8 + .../-find-in-page-feature/stop.md | 8 + .../-find-in-page-feature/unbind.md | 9 + .../index.md | 9 + .../-intent-handler.md | 5 + .../-a-c-t-i-v-e_-s-e-s-s-i-o-n_-i-d.md | 5 + .../-intent-processor/-init-.md | 8 + .../-intent-processor/index.md | 27 ++ .../-intent-processor/process.md | 15 + .../-intent-processor/register-handler.md | 14 + .../-intent-processor/unregister-handler.md | 11 + .../index.md | 15 + .../-on-need-to-request-permissions.md | 5 + ...a-c-t-i-v-i-t-y_-r-e-q-u-e-s-t_-c-o-d-e.md | 5 + .../-prompt-feature/-init-.md | 20 + .../-prompt-feature/index.md | 40 ++ .../-prompt-feature/on-activity-result.md | 14 + .../-prompt-feature/on-permissions-result.md | 19 + .../-prompt-feature/start.md | 11 + .../-prompt-feature/stop.md | 10 + .../index.md | 15 + .../-default-search-use-case/-init-.md | 5 + .../-default-search-use-case/index.md | 17 + .../-default-search-use-case/invoke.md | 20 + .../-search-use-cases/-init-.md | 15 + .../-new-tab-search-use-case/-init-.md | 5 + .../-new-tab-search-use-case/index.md | 17 + .../-new-tab-search-use-case/invoke.md | 21 + .../-search-use-case/index.md | 18 + .../-search-use-case/invoke.md | 5 + .../-search-use-cases/default-search.md | 5 + .../-search-use-cases/index.md | 36 ++ .../-search-use-cases/new-tab-search.md | 5 + .../index.md | 9 + .../-session-bundle-storage/-init-.md | 12 + .../-session-bundle-storage/auto-save.md | 8 + .../-session-bundle-storage/bundles-paged.md | 13 + .../-session-bundle-storage/bundles.md | 8 + .../-session-bundle-storage/current.md | 9 + .../-session-bundle-storage/index.md | 32 ++ .../-session-bundle-storage/remove-all.md | 8 + .../-session-bundle-storage/remove.md | 9 + .../-session-bundle-storage/restore.md | 8 + .../-session-bundle-storage/save.md | 11 + .../-session-bundle-storage/use.md | 8 + .../-session-bundle/id.md | 8 + .../-session-bundle/index.md | 21 + .../-session-bundle/last-saved-at.md | 8 + .../-session-bundle/restore-snapshot.md | 9 + .../-session-bundle/urls.md | 8 + .../index.md | 10 + .../-d-e-f-a-u-l-t_-s-c-r-o-l-l_-f-l-a-g-s.md | 5 + .../-coordinate-scrolling-feature/-init-.md | 11 + .../-coordinate-scrolling-feature/index.md | 44 ++ .../on-loading-state-changed.md | 8 + .../-coordinate-scrolling-feature/start.md | 10 + .../-engine-view-presenter/-init-.md | 8 + .../-engine-view-presenter/index.md | 30 ++ .../on-session-selected.md | 10 + .../-engine-view-presenter/start.md | 8 + .../-engine-view-presenter/stop.md | 8 + .../-full-screen-feature/-init-.md | 8 + .../-full-screen-feature/index.md | 36 ++ .../-full-screen-feature/on-back-pressed.md | 13 + .../on-full-screen-changed.md | 8 + .../-full-screen-feature/start.md | 10 + .../-history-delegate/-init-.md | 8 + .../-history-delegate/get-visited.md | 16 + .../-history-delegate/index.md | 21 + .../-history-delegate/on-title-changed.md | 10 + .../-history-delegate/on-visited.md | 10 + .../-session-feature/-init-.md | 8 + .../-session-feature/index.md | 21 + .../-session-feature/on-back-pressed.md | 13 + .../-session-feature/start.md | 10 + .../-session-feature/stop.md | 10 + .../-clear-data-use-case/index.md | 11 + .../-clear-data-use-case/invoke.md | 8 + .../-default-load-url-use-case/index.md | 11 + .../-default-load-url-use-case/invoke.md | 25 ++ .../-exit-full-screen-use-case/index.md | 11 + .../-exit-full-screen-use-case/invoke.md | 8 + .../-go-back-use-case/index.md | 11 + .../-go-back-use-case/invoke.md | 8 + .../-go-forward-use-case/index.md | 11 + .../-go-forward-use-case/invoke.md | 8 + .../-session-use-cases/-init-.md | 17 + .../-load-data-use-case/index.md | 11 + .../-load-data-use-case/invoke.md | 9 + .../-load-url-use-case/index.md | 21 + .../-load-url-use-case/invoke.md | 5 + .../-reload-url-use-case/index.md | 11 + .../-reload-url-use-case/invoke.md | 12 + .../-request-desktop-site-use-case/index.md | 11 + .../-request-desktop-site-use-case/invoke.md | 8 + .../-stop-loading-use-case/index.md | 11 + .../-stop-loading-use-case/invoke.md | 11 + .../-session-use-cases/clear-data.md | 5 + .../-session-use-cases/exit-fullscreen.md | 5 + .../-session-use-cases/go-back.md | 5 + .../-session-use-cases/go-forward.md | 5 + .../-session-use-cases/index.md | 52 +++ .../-session-use-cases/load-data.md | 5 + .../-session-use-cases/load-url.md | 5 + .../-session-use-cases/reload.md | 5 + .../request-desktop-site.md | 5 + .../-session-use-cases/stop-loading.md | 5 + .../-window-feature/-init-.md | 8 + .../-window-feature/index.md | 20 + .../-window-feature/start.md | 10 + .../-window-feature/stop.md | 10 + .../index.md | 15 + .../-on-need-to-request-permissions.md | 5 + .../-site-permissions-feature/-init-.md | 11 + .../-site-permissions-feature/index.md | 26 ++ .../on-content-permission-deny.md | 13 + .../on-content-permission-granted.md | 15 + .../on-permissions-result.md | 16 + .../-site-permissions-feature/start.md | 8 + .../-site-permissions-feature/stop.md | 8 + .../index.md | 15 + .../-auth-exception-type/-k-e-y_-i-n-f-o.md | 11 + .../-auth-exception-type/index.md | 19 + .../-auth-exception-type/msg.md | 5 + .../-auth-exception/-init-.md | 8 + .../-auth-exception/index.md | 13 + .../-firefox-sync-feature/-init-.md | 19 + .../-firefox-sync-feature/index.md | 32 ++ .../-firefox-sync-feature/sync-running.md | 9 + .../-firefox-sync-feature/sync.md | 16 + .../-fxa-auth-info/-init-.md | 8 + .../-fxa-auth-info/fxa-access-token.md | 5 + .../-fxa-auth-info/index.md | 22 + .../-fxa-auth-info/kid.md | 5 + .../-fxa-auth-info/sync-key.md | 5 + .../-fxa-auth-info/token-server-url.md | 5 + .../-store-sync-status/-init-.md | 5 + .../-store-sync-status/index.md | 17 + .../-store-sync-status/status.md | 5 + .../-sync-result.md | 8 + .../-sync-status-observer/index.md | 15 + .../-sync-status-observer/on-error.md | 11 + .../-sync-status-observer/on-idle.md | 8 + .../-sync-status-observer/on-started.md | 8 + .../mozilla.components.feature.sync/index.md | 31 ++ .../registry.md | 5 + .../-tabs-feature/-init-.md | 8 + .../-tabs-feature/filter-tabs.md | 5 + .../-tabs-feature/index.md | 21 + .../-tabs-feature/start.md | 8 + .../-tabs-feature/stop.md | 8 + .../-tabs-tray-interactor/-init-.md | 9 + .../-tabs-tray-interactor/index.md | 23 + .../-tabs-tray-interactor/on-tab-closed.md | 10 + .../-tabs-tray-interactor/on-tab-selected.md | 10 + .../-tabs-tray-interactor/start.md | 5 + .../-tabs-tray-interactor/stop.md | 5 + .../-tabs-tray-presenter/-init-.md | 9 + .../-tabs-tray-presenter/index.md | 31 ++ .../on-all-sessions-removed.md | 13 + .../-tabs-tray-presenter/on-session-added.md | 10 + .../on-session-removed.md | 10 + .../on-session-selected.md | 10 + .../-tabs-tray-presenter/start.md | 5 + .../-tabs-tray-presenter/stop.md | 5 + .../index.md | 11 + .../-tab-counter-toolbar-button/-init-.md | 8 + .../-tab-counter-toolbar-button/bind.md | 8 + .../create-view.md | 8 + .../-tab-counter-toolbar-button/index.md | 26 ++ .../-tabs-toolbar-feature/-init-.md | 8 + .../-tabs-toolbar-feature/index.md | 13 + .../index.md | 10 + .../-add-new-private-tab-use-case/index.md | 11 + .../-add-new-private-tab-use-case/invoke.md | 25 ++ .../-add-new-tab-use-case/index.md | 11 + .../-add-new-tab-use-case/invoke.md | 25 ++ .../-tabs-use-cases/-init-.md | 8 + .../index.md | 11 + .../invoke.md | 9 + .../-remove-all-tabs-use-case/index.md | 11 + .../-remove-all-tabs-use-case/invoke.md | 5 + .../-remove-tab-use-case/index.md | 11 + .../-remove-tab-use-case/invoke.md | 11 + .../-select-tab-use-case/index.md | 11 + .../-select-tab-use-case/invoke.md | 11 + .../-tabs-use-cases/add-private-tab.md | 5 + .../-tabs-use-cases/add-tab.md | 5 + .../-tabs-use-cases/index.md | 35 ++ .../remove-all-tabs-of-type.md | 5 + .../-tabs-use-cases/remove-all-tabs.md | 5 + .../-tabs-use-cases/remove-tab.md | 5 + .../-tabs-use-cases/select-tab.md | 5 + .../mozilla.components.feature.tabs/index.md | 9 + .../-search-use-case.md | 9 + .../-toolbar-autocomplete-feature/-init-.md | 8 + .../add-domain-provider.md | 5 + .../add-history-storage-provider.md | 5 + .../-toolbar-autocomplete-feature/index.md | 26 ++ .../-toolbar-autocomplete-feature/toolbar.md | 5 + .../-toolbar-feature/-init-.md | 8 + .../-toolbar-feature/index.md | 27 ++ .../-toolbar-feature/on-back-pressed.md | 13 + .../-toolbar-feature/start.md | 10 + .../-toolbar-feature/stop.md | 10 + .../-toolbar-feature/toolbar.md | 5 + .../-toolbar-interactor/-init-.md | 8 + .../-toolbar-interactor/index.md | 20 + .../-toolbar-interactor/start.md | 10 + .../-toolbar-interactor/stop.md | 8 + .../-toolbar-presenter/-init-.md | 9 + .../-toolbar-presenter/index.md | 39 ++ .../-toolbar-presenter/on-progress.md | 8 + .../-toolbar-presenter/on-search.md | 8 + .../-toolbar-presenter/on-security-changed.md | 8 + .../-toolbar-presenter/on-session-selected.md | 10 + .../-toolbar-presenter/on-url-changed.md | 8 + .../-toolbar-presenter/start.md | 8 + .../index.md | 18 + .../-crash-handler-service/-init-.md | 8 + .../-crash-handler-service/index.md | 34 ++ .../on-handle-intent.md | 5 + .../-exception-handler/-init-.md | 8 + .../-exception-handler/index.md | 19 + .../-exception-handler/uncaught-exception.md | 5 + .../index.md | 10 + .../-crash-reporter-activity/-init-.md | 8 + .../-crash-reporter-activity/index.md | 37 ++ .../on-back-pressed.md | 5 + .../-crash-reporter-activity/on-create.md | 5 + .../index.md | 9 + .../-crash-reporter-service/index.md | 20 + .../-crash-reporter-service/report.md | 12 + .../-gecko-crash-reporter.md | 5 + .../-mozilla-socorro-service/-init-.md | 16 + .../-mozilla-socorro-service/index.md | 28 ++ .../-mozilla-socorro-service/report.md | 16 + .../-sentry-service/-init-.md | 15 + .../-sentry-service/index.md | 27 ++ .../-sentry-service/report.md | 16 + .../index.md | 17 + .../-crash-reporter/-init-.md | 21 + .../-prompt-configuration/-init-.md | 8 + .../-prompt-configuration/index.md | 13 + .../-crash-reporter/-prompt/-a-l-w-a-y-s.md | 8 + .../-crash-reporter/-prompt/-n-e-v-e-r.md | 8 + .../-o-n-l-y_-n-a-t-i-v-e_-c-r-a-s-h.md | 8 + .../-crash-reporter/-prompt/index.md | 13 + .../-crash-reporter/enabled.md | 25 ++ .../-crash-reporter/index.md | 46 ++ .../-crash-reporter/install.md | 8 + .../-crash-reporter/submit-report.md | 10 + .../-crash/-native-code-crash/-init-.md | 8 + .../-crash/-native-code-crash/extras-path.md | 15 + .../-crash/-native-code-crash/index.md | 22 + .../-crash/-native-code-crash/is-fatal.md | 15 + .../-native-code-crash/minidump-path.md | 11 + .../-native-code-crash/minidump-success.md | 13 + .../-uncaught-exception-crash/-init-.md | 8 + .../-crash/-uncaught-exception-crash/index.md | 19 + .../-uncaught-exception-crash/throwable.md | 11 + .../-crash/from-intent.md | 5 + .../-crash/index.md | 28 ++ .../-crash/is-crash-intent.md | 5 + .../api/mozilla.components.lib.crash/index.md | 10 + .../-key-store-wrapper/-init-.md | 9 + .../-key-store-wrapper/get-key-for.md | 28 ++ .../-key-store-wrapper/get-key-store.md | 8 + .../-key-store-wrapper/index.md | 24 ++ .../-key-store-wrapper/load-key-store.md | 19 + .../-key-store-wrapper/make-key-for.md | 25 ++ .../-key-store-wrapper/remove-key-for.md | 15 + .../-keystore-exception/-init-.md | 9 + .../-keystore-exception/index.md | 14 + .../-keystore/-init-.md | 20 + .../-keystore/available.md | 13 + .../-keystore/create-decrypt-cipher.md | 26 ++ .../-keystore/create-encrypt-cipher.md | 22 + .../-keystore/decrypt-bytes.md | 23 + .../-keystore/delete-key.md | 11 + .../-keystore/encrypt-bytes.md | 23 + .../-keystore/generate-key.md | 16 + .../-keystore/index.md | 42 ++ .../-keystore/label.md | 11 + .../index.md | 16 + .../-http-u-r-l-connection-client/-init-.md | 8 + .../-http-u-r-l-connection-client/fetch.md | 35 ++ .../-http-u-r-l-connection-client/index.md | 25 ++ .../index.md | 9 + .../-ok-http-client/-init-.md | 8 + .../-ok-http-client/fetch.md | 35 ++ .../-ok-http-client/index.md | 25 ++ .../-request-builder.md | 5 + .../index.md | 15 + .../-ast-node/-init-.md | 11 + .../-ast-node/alternate.md | 5 + .../-ast-node/arguments.md | 5 + .../-ast-node/consequent.md | 5 + .../-ast-node/equals.md | 5 + .../-ast-node/expression.md | 5 + .../-ast-node/from.md | 5 + .../-ast-node/index.md | 42 ++ .../-ast-node/left.md | 5 + .../-ast-node/name.md | 5 + .../-ast-node/operator.md | 5 + .../-ast-node/relative.md | 5 + .../-ast-node/right.md | 5 + .../-ast-node/subject.md | 5 + .../-ast-node/test.md | 5 + .../-ast-node/to-string.md | 5 + .../-ast-node/type.md | 5 + .../-ast-node/value.md | 5 + .../-ast-type/-a-r-r-a-y_-l-i-t-e-r-a-l.md | 5 + .../-b-i-n-a-r-y_-e-x-p-r-e-s-s-i-o-n.md | 5 + ...-n-d-i-t-i-o-n-a-l_-e-x-p-r-e-s-s-i-o-n.md | 5 + .../-f-i-l-t-e-r_-e-x-p-r-e-s-s-i-o-n.md | 5 + .../-ast-type/-i-d-e-n-t-i-f-i-e-r.md | 5 + .../-ast-type/-l-i-t-e-r-a-l.md | 5 + .../-ast-type/-o-b-j-e-c-t_-l-i-t-e-r-a-l.md | 5 + .../-ast-type/-t-r-a-n-s-f-o-r-m.md | 5 + .../-u-n-a-r-y_-e-x-p-r-e-s-s-i-o-n.md | 5 + .../-ast-type/index.md | 19 + .../mozilla.components.lib.jexl.ast/index.md | 10 + .../-jexl-context/-init-.md | 29 ++ .../-jexl-context/get.md | 5 + .../-jexl-context/index.md | 41 ++ .../-jexl-context/set.md | 5 + .../-transform.md | 5 + .../index.md | 15 + .../mozilla.components.lib.jexl.ext/index.md | 14 + .../kotlin.-boolean/index.md | 7 + .../kotlin.-boolean/to-jexl.md | 5 + .../kotlin.-double/index.md | 7 + .../kotlin.-double/to-jexl.md | 5 + .../kotlin.-float/index.md | 7 + .../kotlin.-float/to-jexl.md | 5 + .../kotlin.-int/index.md | 7 + .../kotlin.-int/to-jexl.md | 5 + .../kotlin.-string/index.md | 7 + .../kotlin.-string/to-jexl.md | 5 + .../kotlin.collections.-list/index.md | 7 + .../kotlin.collections.-list/to-jexl-array.md | 5 + .../-grammar-element/-init-.md | 5 + .../-grammar-element/evaluate.md | 5 + .../-grammar-element/index.md | 19 + .../-grammar-element/precedence.md | 5 + .../-grammar-element/type.md | 5 + .../-grammar/-init-.md | 10 + .../-grammar/elements.md | 5 + .../-grammar/index.md | 21 + .../index.md | 10 + .../-token/-init-.md | 8 + .../-token/-type/-b-i-n-a-r-y_-o-p.md | 5 + .../-token/-type/-c-l-o-s-e_-b-r-a-c-k-e-t.md | 5 + .../-token/-type/-c-l-o-s-e_-c-u-r-l.md | 5 + .../-token/-type/-c-l-o-s-e_-p-a-r-e-n.md | 5 + .../-token/-type/-c-o-l-o-n.md | 5 + .../-token/-type/-c-o-m-m-a.md | 5 + .../-token/-type/-d-o-t.md | 5 + .../-token/-type/-i-d-e-n-t-i-f-i-e-r.md | 5 + .../-token/-type/-l-i-t-e-r-a-l.md | 5 + .../-token/-type/-o-p-e-n_-b-r-a-c-k-e-t.md | 5 + .../-token/-type/-o-p-e-n_-c-u-r-l.md | 5 + .../-token/-type/-o-p-e-n_-p-a-r-e-n.md | 5 + .../-token/-type/-p-i-p-e.md | 5 + .../-token/-type/-q-u-e-s-t-i-o-n.md | 5 + .../-token/-type/-u-n-a-r-y_-o-p.md | 5 + .../-token/-type/index.md | 25 ++ .../-token/index.md | 27 ++ .../-token/raw.md | 5 + .../-token/type.md | 5 + .../-token/value.md | 5 + .../index.md | 9 + .../-parser-exception/-init-.md | 5 + .../-parser-exception/index.md | 11 + .../index.md | 9 + .../-jexl-array/-init-.md | 8 + .../-jexl-array/compare-to.md | 8 + .../-jexl-array/div.md | 8 + .../-jexl-array/equals.md | 5 + .../-jexl-array/hash-code.md | 5 + .../-jexl-array/index.md | 32 ++ .../-jexl-array/plus.md | 8 + .../-jexl-array/times.md | 8 + .../-jexl-array/to-boolean.md | 8 + .../-jexl-array/to-string.md | 5 + .../-jexl-array/value.md | 8 + .../-jexl-boolean/-init-.md | 8 + .../-jexl-boolean/compare-to.md | 8 + .../-jexl-boolean/div.md | 8 + .../-jexl-boolean/equals.md | 5 + .../-jexl-boolean/hash-code.md | 5 + .../-jexl-boolean/index.md | 33 ++ .../-jexl-boolean/plus.md | 8 + .../-jexl-boolean/times.md | 8 + .../-jexl-boolean/to-boolean.md | 8 + .../-jexl-boolean/to-int.md | 5 + .../-jexl-boolean/to-string.md | 5 + .../-jexl-boolean/value.md | 8 + .../-jexl-double/-init-.md | 8 + .../-jexl-double/compare-to.md | 8 + .../-jexl-double/div.md | 8 + .../-jexl-double/equals.md | 5 + .../-jexl-double/hash-code.md | 5 + .../-jexl-double/index.md | 32 ++ .../-jexl-double/plus.md | 8 + .../-jexl-double/times.md | 8 + .../-jexl-double/to-boolean.md | 8 + .../-jexl-double/to-string.md | 5 + .../-jexl-double/value.md | 8 + .../-jexl-integer/-init-.md | 8 + .../-jexl-integer/compare-to.md | 8 + .../-jexl-integer/div.md | 8 + .../-jexl-integer/equals.md | 5 + .../-jexl-integer/hash-code.md | 5 + .../-jexl-integer/index.md | 32 ++ .../-jexl-integer/plus.md | 8 + .../-jexl-integer/times.md | 8 + .../-jexl-integer/to-boolean.md | 8 + .../-jexl-integer/to-string.md | 5 + .../-jexl-integer/value.md | 8 + .../-jexl-object/-init-.md | 8 + .../-jexl-object/compare-to.md | 8 + .../-jexl-object/div.md | 8 + .../-jexl-object/equals.md | 5 + .../-jexl-object/hash-code.md | 5 + .../-jexl-object/index.md | 32 ++ .../-jexl-object/plus.md | 8 + .../-jexl-object/times.md | 8 + .../-jexl-object/to-boolean.md | 8 + .../-jexl-object/to-string.md | 5 + .../-jexl-object/value.md | 8 + .../-jexl-string/-init-.md | 8 + .../-jexl-string/compare-to.md | 8 + .../-jexl-string/div.md | 8 + .../-jexl-string/equals.md | 5 + .../-jexl-string/hash-code.md | 5 + .../-jexl-string/index.md | 32 ++ .../-jexl-string/plus.md | 8 + .../-jexl-string/times.md | 8 + .../-jexl-string/to-boolean.md | 8 + .../-jexl-string/to-string.md | 5 + .../-jexl-string/value.md | 8 + .../-jexl-undefined/-init-.md | 8 + .../-jexl-undefined/compare-to.md | 8 + .../-jexl-undefined/div.md | 8 + .../-jexl-undefined/equals.md | 5 + .../-jexl-undefined/hash-code.md | 5 + .../-jexl-undefined/index.md | 32 ++ .../-jexl-undefined/plus.md | 8 + .../-jexl-undefined/times.md | 8 + .../-jexl-undefined/to-boolean.md | 8 + .../-jexl-undefined/to-string.md | 5 + .../-jexl-undefined/value.md | 8 + .../-jexl-value/compare-to.md | 5 + .../-jexl-value/div.md | 5 + .../-jexl-value/index.md | 35 ++ .../-jexl-value/plus.md | 5 + .../-jexl-value/times.md | 5 + .../-jexl-value/to-boolean.md | 5 + .../-jexl-value/value.md | 5 + .../index.md | 16 + .../-jexl-exception/-init-.md | 8 + .../-jexl-exception/index.md | 13 + .../-jexl/-init-.md | 5 + .../-jexl/add-transform.md | 16 + .../-jexl/evaluate-boolean-expression.md | 10 + .../-jexl/evaluate.md | 22 + .../-jexl/index.md | 19 + docs/api/mozilla.components.lib.jexl/index.md | 15 + .../-public-suffix-list/-init-.md | 17 + .../get-public-suffix-plus-one.md | 17 + .../-public-suffix-list/get-public-suffix.md | 16 + .../-public-suffix-list/index.md | 32 ++ .../-public-suffix-list/is-public-suffix.md | 20 + .../-public-suffix-list/prefetch.md | 8 + .../strip-public-suffix.md | 17 + .../index.md | 9 + .../-job-scheduler-sync-scheduler/-init-.md | 12 + .../-job-scheduler-sync-scheduler/index.md | 24 ++ .../-job-scheduler-sync-scheduler/schedule.md | 20 + .../-sync-job/-init-.md | 8 + .../-sync-job/get-fretboard.md | 12 + .../-sync-job/index.md | 36 ++ .../-sync-job/on-start-job.md | 5 + .../-sync-job/on-stop-job.md | 5 + .../index.md | 10 + .../-sync-worker/-init-.md | 5 + .../-sync-worker/do-work.md | 5 + .../-sync-worker/fretboard.md | 12 + .../-sync-worker/index.md | 23 + .../-work-manager-sync-scheduler/-init-.md | 9 + .../-work-manager-sync-scheduler/index.md | 20 + .../-work-manager-sync-scheduler/schedule.md | 12 + .../index.md | 10 + .../-http-client/get.md | 18 + .../-http-client/index.md | 15 + .../-kinto-experiment-source/-init-.md | 9 + .../get-experiments.md | 21 + .../-kinto-experiment-source/index.md | 20 + .../index.md | 10 + .../-flat-file-experiment-storage/-init-.md | 11 + .../-flat-file-experiment-storage/index.md | 24 ++ .../-flat-file-experiment-storage/retrieve.md | 13 + .../-flat-file-experiment-storage/save.md | 13 + .../index.md | 9 + .../-experiment-descriptor/-init-.md | 8 + .../-experiment-descriptor/index.md | 19 + .../-experiment-descriptor/name.md | 11 + .../-experiment-download-exception/-init-.md | 6 + .../-experiment-download-exception/index.md | 13 + .../-experiment-payload/-init-.md | 8 + .../-experiment-payload/get-boolean-list.md | 15 + .../-experiment-payload/get-double-list.md | 15 + .../-experiment-payload/get-int-list.md | 15 + .../-experiment-payload/get-keys.md | 11 + .../-experiment-payload/get-long-list.md | 15 + .../-experiment-payload/get-string-list.md | 15 + .../-experiment-payload/get.md | 15 + .../-experiment-payload/index.md | 26 ++ .../-experiment-payload/put.md | 13 + .../-experiment-source/get-experiments.md | 19 + .../-experiment-source/index.md | 20 + .../-experiment-storage/index.md | 21 + .../-experiment-storage/retrieve.md | 11 + .../-experiment-storage/save.md | 11 + .../-experiment/-bucket/-init-.md | 5 + .../-experiment/-bucket/index.md | 18 + .../-experiment/-bucket/max.md | 8 + .../-experiment/-bucket/min.md | 8 + .../-experiment/-init-.md | 10 + .../-experiment/-matcher/-init-.md | 5 + .../-experiment/-matcher/app-id.md | 8 + .../-experiment/-matcher/country.md | 8 + .../-experiment/-matcher/device.md | 8 + .../-experiment/-matcher/index.md | 24 ++ .../-experiment/-matcher/language.md | 8 + .../-experiment/-matcher/manufacturer.md | 8 + .../-experiment/-matcher/regions.md | 8 + .../-experiment/-matcher/release-channel.md | 8 + .../-experiment/-matcher/version.md | 8 + .../-experiment/bucket.md | 8 + .../-experiment/description.md | 8 + .../-experiment/equals.md | 11 + .../-experiment/hash-code.md | 5 + .../-experiment/index.md | 41 ++ .../-experiment/last-modified.md | 8 + .../-experiment/match.md | 8 + .../-experiment/name.md | 8 + .../-experiment/payload.md | 8 + .../-experiment/schema.md | 9 + .../-experiments-snapshot/-init-.md | 8 + .../-experiments-snapshot/experiments.md | 8 + .../-experiments-snapshot/index.md | 20 + .../-experiments-snapshot/last-modified.md | 8 + .../-fretboard/-init-.md | 8 + .../-fretboard/clear-all-overrides-now.md | 15 + .../-fretboard/clear-all-overrides.md | 11 + .../-fretboard/clear-override-now.md | 17 + .../-fretboard/clear-override.md | 13 + .../-fretboard/experiments.md | 8 + .../-fretboard/get-active-experiments.md | 15 + .../-fretboard/get-experiment.md | 15 + .../-fretboard/get-experiments-map.md | 15 + .../-fretboard/get-user-bucket.md | 12 + .../-fretboard/index.md | 38 ++ .../-fretboard/is-in-experiment.md | 18 + .../-fretboard/load-experiments.md | 8 + .../-fretboard/set-override-now.md | 19 + .../-fretboard/set-override.md | 15 + .../-fretboard/update-experiments.md | 9 + .../-fretboard/with-experiment.md | 15 + .../-j-s-o-n-experiment-parser/-init-.md | 8 + .../-j-s-o-n-experiment-parser/from-json.md | 15 + .../-j-s-o-n-experiment-parser/index.md | 20 + .../-j-s-o-n-experiment-parser/to-json.md | 15 + .../-values-provider/-init-.md | 9 + .../-values-provider/get-app-id.md | 11 + .../-values-provider/get-client-id.md | 8 + .../-values-provider/get-country.md | 11 + .../-values-provider/get-device.md | 11 + .../-values-provider/get-language.md | 11 + .../-values-provider/get-manufacturer.md | 11 + .../-values-provider/get-region.md | 11 + .../-values-provider/get-release-channel.md | 11 + .../-values-provider/get-version.md | 11 + .../-values-provider/index.md | 28 ++ .../index.md | 23 + .../-access-token-info/-init-.md | 8 + .../-access-token-info/expires-at.md | 11 + .../-access-token-info/index.md | 21 + .../-access-token-info/key.md | 11 + .../-access-token-info/token.md | 11 + .../-account-observer/index.md | 16 + .../-account-observer/on-authenticated.md | 11 + .../-account-observer/on-error.md | 11 + .../-account-observer/on-logged-out.md | 8 + .../-account-observer/on-profile-updated.md | 11 + .../-authenticated-no-profile.md | 5 + .../-authenticated-with-profile.md | 5 + .../-account-state/-not-authenticated.md | 5 + .../-account-state/-start.md | 5 + .../-account-state/index.md | 14 + .../-account-storage/clear.md | 5 + .../-account-storage/index.md | 19 + .../-account-storage/read.md | 5 + .../-account-storage/write.md | 5 + .../-avatar/-init-.md | 5 + .../-avatar/index.md | 18 + .../-avatar/is-default.md | 5 + .../-avatar/url.md | 5 + .../mozilla.components.service.fxa/-config.md | 5 + .../-f-x-a_-s-t-a-t-e_-k-e-y.md | 5 + .../-f-x-a_-s-t-a-t-e_-p-r-e-f-s_-k-e-y.md | 5 + .../-init-.md | 13 + .../index.md | 19 + .../begin-o-auth-flow.md | 5 + .../begin-pairing-flow.md | 5 + .../complete-o-auth-flow.md | 5 + .../get-access-token.md | 5 + .../-firefox-account-shaped/get-profile.md | 6 + .../get-token-server-endpoint-u-r-l.md | 5 + .../-firefox-account-shaped/index.md | 25 ++ .../to-j-s-o-n-string.md | 5 + .../-firefox-account/-init-.md | 11 + .../-firefox-account/begin-o-auth-flow.md | 19 + .../-firefox-account/begin-pairing-flow.md | 8 + .../-firefox-account/close.md | 5 + .../-firefox-account/complete-o-auth-flow.md | 13 + .../-firefox-account/from-j-s-o-n-string.md | 12 + .../-firefox-account/get-access-token.md | 23 + .../get-connection-success-u-r-l.md | 8 + .../-firefox-account/get-profile.md | 38 ++ .../get-token-server-endpoint-u-r-l.md | 10 + .../-firefox-account/index.md | 33 ++ .../-firefox-account/to-j-s-o-n-string.md | 15 + .../-fxa-account-manager/-init-.md | 20 + .../-fxa-account-manager/account-profile.md | 5 + .../authenticated-account.md | 5 + .../begin-authentication.md | 5 + .../-fxa-account-manager/close.md | 5 + .../-fxa-account-manager/create-account.md | 5 + .../finish-authentication.md | 5 + .../-fxa-account-manager/index.md | 40 ++ .../-fxa-account-manager/init.md | 8 + .../-fxa-account-manager/logout.md | 5 + .../-fxa-account-manager/update-profile.md | 5 + .../-fxa-exception.md | 8 + .../-fxa-network-exception.md | 8 + .../-fxa-panic-exception.md | 8 + .../-fxa-unauthorized-exception.md | 8 + .../-fxa-unspecified-exception.md | 9 + .../-o-auth-scoped-key/-init-.md | 8 + .../-o-auth-scoped-key/index.md | 20 + .../-o-auth-scoped-key/k.md | 11 + .../-o-auth-scoped-key/kid.md | 11 + .../-profile/-init-.md | 5 + .../-profile/avatar.md | 5 + .../-profile/display-name.md | 5 + .../-profile/email.md | 5 + .../-profile/index.md | 20 + .../-profile/uid.md | 5 + .../-shared-pref-account-storage/-init-.md | 5 + .../-shared-pref-account-storage/clear.md | 8 + .../-shared-pref-account-storage/context.md | 5 + .../-shared-pref-account-storage/index.md | 25 ++ .../-shared-pref-account-storage/read.md | 11 + .../-shared-pref-account-storage/write.md | 8 + .../mozilla.components.service.fxa/index.md | 43 ++ .../-configuration/-init-.md | 8 + .../-configuration/connection-timeout.md | 13 + .../-configuration/index.md | 24 ++ .../-configuration/log-pings.md | 11 + .../-configuration/max-events.md | 11 + .../-configuration/read-timeout.md | 13 + .../-configuration/server-endpoint.md | 11 + .../-configuration/user-agent.md | 11 + .../index.md | 9 + .../-recorded-event-data/-init-.md | 5 + .../-recorded-event-data/category.md | 5 + .../-recorded-event-data/extra.md | 5 + .../-recorded-event-data/index.md | 22 + .../-recorded-event-data/ms-since-start.md | 5 + .../-recorded-event-data/name.md | 5 + .../-recorded-event-data/object-id.md | 5 + .../-recorded-event-data/value.md | 5 + .../index.md | 9 + .../-boolean-metric-type/-init-.md | 13 + .../-boolean-metric-type/category.md | 8 + .../default-storage-destinations.md | 12 + .../-boolean-metric-type/disabled.md | 8 + .../-boolean-metric-type/index.md | 50 +++ .../-boolean-metric-type/lifetime.md | 8 + .../-boolean-metric-type/name.md | 8 + .../-boolean-metric-type/send-in-pings.md | 8 + .../-boolean-metric-type/set.md | 11 + .../-boolean-metric-type/test-get-value.md | 21 + .../-boolean-metric-type/test-has-value.md | 17 + .../-common-metric-data/category.md | 5 + .../default-storage-destinations.md | 10 + .../-common-metric-data/disabled.md | 5 + .../-common-metric-data/get-storage-names.md | 10 + .../-common-metric-data/identifier.md | 5 + .../-common-metric-data/index.md | 39 ++ .../-common-metric-data/lifetime.md | 5 + .../-common-metric-data/name.md | 5 + .../-common-metric-data/send-in-pings.md | 5 + .../-common-metric-data/should-record.md | 5 + .../-counter-metric-type/-init-.md | 14 + .../-counter-metric-type/add.md | 12 + .../-counter-metric-type/category.md | 8 + .../default-storage-destinations.md | 12 + .../-counter-metric-type/disabled.md | 8 + .../-counter-metric-type/index.md | 51 +++ .../-counter-metric-type/lifetime.md | 8 + .../-counter-metric-type/name.md | 8 + .../-counter-metric-type/send-in-pings.md | 8 + .../-counter-metric-type/test-get-value.md | 21 + .../-counter-metric-type/test-has-value.md | 17 + .../-event-metric-type/-init-.md | 14 + .../-event-metric-type/allowed-extra-keys.md | 5 + .../-event-metric-type/category.md | 8 + .../default-storage-destinations.md | 12 + .../-event-metric-type/disabled.md | 8 + .../-event-metric-type/index.md | 53 +++ .../-event-metric-type/lifetime.md | 8 + .../-event-metric-type/name.md | 8 + .../-event-metric-type/objects.md | 5 + .../-event-metric-type/record.md | 19 + .../-event-metric-type/send-in-pings.md | 8 + .../-event-metric-type/test-get-value.md | 21 + .../-event-metric-type/test-has-value.md | 17 + .../get-upload-enabled.md | 8 + .../-glean-internal-a-p-i/handle-event.md | 17 + .../-glean-internal-a-p-i/index.md | 23 + .../-glean-internal-a-p-i/initialize.md | 21 + .../set-experiment-active.md | 18 + .../set-experiment-inactive.md | 11 + .../set-upload-enabled.md | 16 + .../test-clear-all-data.md | 9 + .../-glean/-ping-event/-background.md | 8 + .../-glean/-ping-event/-default.md | 8 + .../-glean/-ping-event/index.md | 14 + .../-glean/index.md | 23 + .../-lifetime/-application.md | 8 + .../-lifetime/-ping.md | 8 + .../-lifetime/-user.md | 8 + .../-lifetime/index.md | 15 + .../-string-list-metric-type/-init-.md | 14 + .../-m-a-x_-s-t-r-i-n-g_-l-e-n-g-t-h.md | 5 + .../-string-list-metric-type/add.md | 17 + .../-string-list-metric-type/category.md | 8 + .../default-storage-destinations.md | 12 + .../-string-list-metric-type/disabled.md | 8 + .../-string-list-metric-type/index.md | 58 +++ .../-string-list-metric-type/lifetime.md | 8 + .../-string-list-metric-type/name.md | 8 + .../-string-list-metric-type/send-in-pings.md | 8 + .../-string-list-metric-type/set.md | 15 + .../test-get-value.md | 21 + .../test-has-value.md | 17 + .../-string-metric-type/-init-.md | 14 + .../-string-metric-type/category.md | 8 + .../default-storage-destinations.md | 12 + .../-string-metric-type/disabled.md | 8 + .../-string-metric-type/index.md | 51 +++ .../-string-metric-type/lifetime.md | 8 + .../-string-metric-type/name.md | 8 + .../-string-metric-type/send-in-pings.md | 8 + .../-string-metric-type/set.md | 12 + .../-string-metric-type/test-get-value.md | 21 + .../-string-metric-type/test-has-value.md | 17 + .../-time-unit/-day.md | 5 + .../-time-unit/-hour.md | 5 + .../-time-unit/-microsecond.md | 5 + .../-time-unit/-millisecond.md | 5 + .../-time-unit/-minute.md | 5 + .../-time-unit/-nanosecond.md | 5 + .../-time-unit/-second.md | 5 + .../-time-unit/index.md | 20 + .../-timespan-metric-type/-init-.md | 13 + .../-timespan-metric-type/cancel.md | 8 + .../-timespan-metric-type/category.md | 8 + .../default-storage-destinations.md | 12 + .../-timespan-metric-type/disabled.md | 8 + .../-timespan-metric-type/index.md | 53 +++ .../-timespan-metric-type/lifetime.md | 8 + .../-timespan-metric-type/name.md | 8 + .../-timespan-metric-type/send-in-pings.md | 8 + .../-timespan-metric-type/start.md | 10 + .../-timespan-metric-type/stop-and-sum.md | 9 + .../-timespan-metric-type/test-get-value.md | 21 + .../-timespan-metric-type/test-has-value.md | 17 + .../-timespan-metric-type/time-unit.md | 5 + .../-uuid-metric-type/-init-.md | 13 + .../-uuid-metric-type/category.md | 8 + .../default-storage-destinations.md | 12 + .../-uuid-metric-type/disabled.md | 8 + .../-uuid-metric-type/generate-and-set.md | 11 + .../-uuid-metric-type/index.md | 51 +++ .../-uuid-metric-type/lifetime.md | 8 + .../-uuid-metric-type/name.md | 8 + .../-uuid-metric-type/send-in-pings.md | 8 + .../-uuid-metric-type/set.md | 11 + .../-uuid-metric-type/test-get-value.md | 21 + .../-uuid-metric-type/test-has-value.md | 17 + .../mozilla.components.service.glean/index.md | 20 + .../-async-logins-storage-adapter/-init-.md | 8 + .../-async-logins-storage-adapter/add.md | 35 ++ .../-async-logins-storage-adapter/close.md | 5 + .../-async-logins-storage-adapter/delete.md | 16 + .../ensure-locked.md | 11 + .../ensure-unlocked.md | 22 + .../for-database.md | 8 + .../-async-logins-storage-adapter/get.md | 16 + .../in-memory.md | 8 + .../-async-logins-storage-adapter/index.md | 40 ++ .../is-locked.md | 10 + .../-async-logins-storage-adapter/list.md | 14 + .../-async-logins-storage-adapter/lock.md | 13 + .../-async-logins-storage-adapter/sync.md | 20 + .../-async-logins-storage-adapter/touch.md | 17 + .../-async-logins-storage-adapter/unlock.md | 38 ++ .../-async-logins-storage-adapter/update.md | 29 ++ .../wipe-local.md | 14 + .../-async-logins-storage-adapter/wipe.md | 14 + .../-async-logins-storage/add.md | 33 ++ .../-async-logins-storage/delete.md | 14 + .../-async-logins-storage/ensure-locked.md | 9 + .../-async-logins-storage/ensure-unlocked.md | 16 + .../-async-logins-storage/get.md | 14 + .../-async-logins-storage/index.md | 33 ++ .../-async-logins-storage/is-locked.md | 8 + .../-async-logins-storage/list.md | 12 + .../-async-logins-storage/lock.md | 11 + .../-async-logins-storage/sync.md | 18 + .../-async-logins-storage/touch.md | 15 + .../-async-logins-storage/unlock.md | 34 ++ .../-async-logins-storage/update.md | 27 ++ .../-async-logins-storage/wipe-local.md | 12 + .../-async-logins-storage/wipe.md | 12 + .../-id-collision-exception.md | 12 + .../-invalid-key-exception.md | 13 + .../-invalid-record-exception.md | 13 + .../-logins-storage-exception.md | 15 + .../-mismatched-lock-exception.md | 8 + .../-no-such-record-exception.md | 9 + .../-request-failed-exception.md | 8 + .../-server-password.md | 8 + .../-sync-auth-invalid-exception.md | 11 + .../-sync-unlock-info.md | 9 + .../-syncable-logins-store/-init-.md | 12 + .../-syncable-logins-store/index.md | 31 ++ .../-syncable-logins-store/key.md | 5 + .../-syncable-logins-store/store.md | 5 + .../-syncable-logins-store/sync.md | 17 + .../-syncable-logins-store/with-unlocked.md | 12 + .../index.md | 26 ++ .../-padding/-init-.md | 17 + .../-padding/bottom.md | 8 + .../-padding/index.md | 32 ++ .../-padding/left.md | 8 + .../-padding/right.md | 8 + .../-padding/top.md | 8 + .../index.md | 9 + .../-log-fact-processor/-init-.md | 8 + .../-log-fact-processor/index.md | 25 ++ .../-log-fact-processor/process.md | 10 + .../index.md | 9 + .../-action/-c-l-i-c-k.md | 8 + .../-action/-c-o-m-m-i-t.md | 8 + .../-action/-i-n-t-e-r-a-c-t-i-o-n.md | 10 + .../-action/-t-o-g-g-l-e.md | 11 + .../-action/index.md | 16 + .../-fact-processor/index.md | 25 ++ .../-fact-processor/process.md | 8 + .../-fact/-init-.md | 8 + .../-fact/action.md | 11 + .../-fact/component.md | 11 + .../-fact/index.md | 29 ++ .../-fact/item.md | 11 + .../-fact/metadata.md | 11 + .../-fact/value.md | 11 + .../-facts/collect.md | 8 + .../-facts/index.md | 14 + .../-facts/register-processor.md | 8 + .../collect.md | 8 + .../index.md | 19 + .../register.md | 8 + .../-back-handler/index.md | 23 + .../-back-handler/on-back-pressed.md | 10 + .../-lifecycle-aware-feature/index.md | 31 ++ .../-lifecycle-aware-feature/start.md | 5 + .../-lifecycle-aware-feature/stop.md | 5 + .../-view-bound-feature-wrapper/-init-.md | 51 +++ .../-view-bound-feature-wrapper/clear.md | 8 + .../-view-bound-feature-wrapper/get.md | 8 + .../-view-bound-feature-wrapper/index.md | 62 +++ .../on-back-pressed.md | 9 + .../-view-bound-feature-wrapper/set.md | 15 + .../with-feature.md | 8 + .../index.md | 11 + .../-logger/-init-.md | 11 + .../-logger/debug.md | 9 + .../-logger/error.md | 9 + .../-logger/index.md | 37 ++ .../-logger/info.md | 9 + .../-logger/measure.md | 15 + .../-logger/warn.md | 9 + .../index.md | 9 + .../-android-log-sink/-init-.md | 11 + .../-android-log-sink/index.md | 23 + .../-android-log-sink/log.md | 10 + .../-log-sink/index.md | 17 + .../-log-sink/log.md | 5 + .../index.md | 10 + .../-consumable-stream/append.md | 15 + .../-consumable-stream/consume-all-by.md | 16 + .../-consumable-stream/consume-all.md | 16 + .../-consumable-stream/consume-next-by.md | 16 + .../-consumable-stream/consume-next.md | 16 + .../-consumable-stream/index.md | 22 + .../-consumable-stream/is-consumed.md | 8 + .../-consumable-stream/is-empty.md | 8 + .../-consumable-stream/remove-consumed.md | 11 + .../-consumable-stream/remove.md | 15 + .../-consumable/consume-by.md | 9 + .../-consumable/consume.md | 8 + .../-consumable/empty.md | 8 + .../-consumable/from.md | 8 + .../-consumable/index.md | 23 + .../-consumable/is-consumed.md | 8 + .../-consumable/stream.md | 8 + .../-observable/index.md | 39 ++ .../-observable/notify-observers.md | 11 + .../-observable/pause-observer.md | 12 + .../-observable/register.md | 36 ++ .../-observable/resume-observer.md | 13 + .../-observable/unregister-observers.md | 8 + .../-observable/unregister.md | 11 + .../-observable/wrap-consumers.md | 8 + .../-observer-registry/-init-.md | 9 + .../-observer-registry/index.md | 26 ++ .../-observer-registry/notify-observers.md | 13 + .../-observer-registry/pause-observer.md | 14 + .../-observer-registry/register.md | 42 ++ .../-observer-registry/resume-observer.md | 15 + .../unregister-observers.md | 10 + .../-observer-registry/unregister.md | 13 + .../-observer-registry/wrap-consumers.md | 10 + .../index.md | 12 + .../add-observers.md | 8 + .../index.md | 7 + .../index.md | 9 + .../index.md | 7 + .../read-j-s-o-n-object.md | 12 + .../android.content.res.-resources/index.md | 7 + .../px-to-dp.md | 8 + .../index.md | 10 + .../app-version-name.md | 9 + .../android.content.-context/index.md | 11 + .../is-o-s-on-low-memory.md | 8 + .../is-permission-granted.md | 9 + .../android.content.-context/share.md | 17 + .../system-service.md | 8 + .../index.md | 9 + .../index.md | 7 + .../to-bitmap.md | 8 + .../index.md | 9 + .../android.graphics.-bitmap/index.md | 8 + .../android.graphics.-bitmap/to-data-uri.md | 8 + .../with-rounded-corners.md | 14 + .../index.md | 9 + .../index.md | 11 + .../kotlin.collections.-map/index.md | 7 + .../kotlin.collections.-map/to-j-s-o-n.md | 8 + .../org.json.-j-s-o-n-array/as-sequence.md | 5 + .../org.json.-j-s-o-n-array/index.md | 8 + .../org.json.-j-s-o-n-array/to-list.md | 11 + .../org.json.-j-s-o-n-object/index.md | 12 + .../org.json.-j-s-o-n-object/merge-with.md | 13 + .../put-if-not-null.md | 8 + .../org.json.-j-s-o-n-object/sort-keys.md | 8 + .../org.json.-j-s-o-n-object/try-get-int.md | 9 + .../org.json.-j-s-o-n-object/try-get-long.md | 9 + .../try-get-string.md | 9 + .../index.md | 7 + .../reset-after.md | 13 + .../index.md | 9 + .../-base64/encode-to-uri-string.md | 5 + .../-base64/index.md | 11 + .../index.md | 9 + .../enter-to-immersive-mode.md | 8 + .../exit-immersive-mode-if-needed.md | 8 + .../android.app.-activity/index.md | 8 + .../android.view.-view-group/for-each.md | 8 + .../android.view.-view-group/index.md | 7 + .../android.view.-view/hide-keyboard.md | 8 + .../android.view.-view/index.md | 14 + .../android.view.-view/is-gone.md | 8 + .../android.view.-view/is-invisible.md | 8 + .../android.view.-view/is-l-t-r.md | 8 + .../android.view.-view/is-r-t-l.md | 8 + .../android.view.-view/is-visible.md | 8 + .../android.view.-view/set-padding.md | 8 + .../android.view.-view/show-keyboard.md | 12 + .../index.md | 11 + .../index.md | 11 + .../kotlin.-char/-e-l-l-i-p-s-i-s.md | 9 + .../kotlin.-char/index.md | 7 + .../kotlin.-string/index.md | 12 + .../kotlin.-string/is-email.md | 5 + .../kotlin.-string/is-geo-location.md | 5 + .../kotlin.-string/is-phone.md | 5 + .../kotlin.-string/is-url.md | 8 + .../kotlin.-string/to-date.md | 18 + .../kotlin.-string/to-normalized-url.md | 8 + .../kotlin.collections.-map/index.md | 7 + .../kotlin.collections.-map/to-bundle.md | 8 + .../-rust-log/disable.md | 8 + .../-rust-log/enable.md | 25 ++ .../-rust-log/index.md | 13 + .../-rust-log/set-max-level.md | 25 ++ .../index.md | 9 + .../grant-permission.md | 12 + .../index.md | 9 + .../-k-argument-captor/-init-.md | 5 + .../-k-argument-captor/all-values.md | 5 + .../-k-argument-captor/capture.md | 5 + .../-k-argument-captor/index.md | 24 ++ .../-k-argument-captor/value.md | 11 + .../mozilla.components.support.test/any.md | 10 + .../argument-captor.md | 8 + .../create-instance.md | 5 + .../api/mozilla.components.support.test/eq.md | 10 + .../expect-exception.md | 8 + .../mozilla.components.support.test/index.md | 21 + .../mock-motion-event.md | 9 + .../mozilla.components.support.test/mock.md | 15 + .../-color-utils/get-readable-text-color.md | 8 + .../-color-utils/index.md | 11 + .../-domain-match/-init-.md | 5 + .../-domain-match/index.md | 18 + .../-domain-match/matched-segment.md | 5 + .../-domain-match/url.md | 5 + .../-download-utils/guess-file-name.md | 11 + .../-download-utils/index.md | 11 + .../-drawable-utils/index.md | 11 + .../-drawable-utils/load-and-tint-drawable.md | 8 + .../-safe-bundle/-init-.md | 12 + .../-safe-bundle/get-parcelable.md | 5 + .../-safe-bundle/get-string.md | 5 + .../-safe-bundle/index.md | 24 ++ .../-safe-intent/-init-.md | 10 + .../-safe-intent/action.md | 5 + .../-safe-intent/categories.md | 5 + .../-safe-intent/data-string.md | 5 + .../-safe-intent/data.md | 5 + .../-safe-intent/extras.md | 5 + .../-safe-intent/flags.md | 5 + .../-safe-intent/get-boolean-extra.md | 5 + .../-safe-intent/get-bundle-extra.md | 5 + .../-safe-intent/get-char-sequence-extra.md | 5 + .../-safe-intent/get-int-extra.md | 5 + .../get-parcelable-array-list-extra.md | 5 + .../-safe-intent/get-parcelable-extra.md | 5 + .../get-string-array-list-extra.md | 5 + .../-safe-intent/get-string-extra.md | 5 + .../-safe-intent/has-extra.md | 5 + .../-safe-intent/index.md | 42 ++ .../-safe-intent/is-launcher-intent.md | 5 + .../-safe-intent/unsafe.md | 5 + .../get-status-bar-height.md | 8 + .../-status-bar-utils/index.md | 11 + .../-thread-utils/assert-on-ui-thread.md | 5 + .../-thread-utils/index.md | 15 + .../post-to-background-thread.md | 6 + .../post-to-main-thread-delayed.md | 5 + .../-thread-utils/post-to-main-thread.md | 5 + .../-thread-utils/set-handler-for-test.md | 5 + .../-web-u-r-l-finder/-init-.md | 5 + .../-web-u-r-l-finder/best-web-u-r-l.md | 14 + .../-web-u-r-l-finder/index.md | 23 + .../mozilla.components.support.utils/index.md | 23 + .../segment-aware-domain-match.md | 5 + .../-fetch-test-cases/-init-.md | 10 + .../-fetch-test-cases/create-new-client.md | 8 + .../-fetch-test-cases/create-web-server.md | 8 + .../get200-overriding-default-headers.md | 5 + .../get200-with-default-headers.md | 5 + ...uplicated-cache-control-request-headers.md | 5 + ...plicated-cache-control-response-headers.md | 5 + .../get200-with-gzipped-body.md | 5 + .../-fetch-test-cases/get200-with-headers.md | 5 + .../get200-with-read-timeout.md | 5 + .../get200-with-string-body.md | 5 + .../get200-with-user-agent.md | 5 + .../get302-follow-redirects-disabled.md | 5 + .../get302-follow-redirects.md | 5 + .../-fetch-test-cases/get404-with-body.md | 5 + .../-fetch-test-cases/index.md | 36 ++ .../-fetch-test-cases/post200-with-body.md | 5 + .../-fetch-test-cases/put201-file-upload.md | 5 + .../index.md | 9 + .../-lint-issue-registry/-init-.md | 8 + .../-lint-issue-registry/api.md | 5 + .../-lint-issue-registry/index.md | 20 + .../-lint-issue-registry/issues.md | 5 + .../-lint-log-checks/-init-.md | 8 + .../get-applicable-method-names.md | 5 + .../-lint-log-checks/index.md | 26 ++ .../-lint-log-checks/issues.md | 5 + .../-lint-log-checks/visit-method.md | 5 + .../mozilla.components.tooling.lint/index.md | 10 + .../apply-autocomplete-result.md | 8 + .../-autocomplete-view/index.md | 26 ++ .../no-autocomplete-result.md | 8 + .../-autocomplete-view/original-text.md | 8 + .../-a-u-t-o-c-o-m-p-l-e-t-e_-s-p-a-n.md | 5 + .../-autocomplete-result/-init-.md | 5 + .../-autocomplete-result/index.md | 25 ++ .../-autocomplete-result/source.md | 5 + .../-autocomplete-result/starts-with.md | 5 + .../-autocomplete-result/text.md | 5 + .../-autocomplete-result/total-items.md | 5 + ...l-e-t-e_-b-a-c-k-g-r-o-u-n-d_-c-o-l-o-r.md | 5 + ...-t-h-o-d_-a-m-a-z-o-n_-e-c-h-o_-s-h-o-w.md | 5 + .../-i-n-p-u-t_-m-e-t-h-o-d_-s-o-n-y.md | 5 + .../-inline-autocomplete-edit-text/-init-.md | 26 ++ .../apply-autocomplete-result.md | 14 + .../autocomplete-result.md | 5 + .../get-text.md | 5 + .../-inline-autocomplete-edit-text/index.md | 96 +++++ .../no-autocomplete-result.md | 10 + .../non-autocomplete-text.md | 5 + .../on-attached-to-window.md | 5 + .../on-create-input-connection.md | 13 + .../on-focus-changed.md | 5 + .../on-key-pre-ime.md | 5 + .../on-selection-changed.md | 5 + .../on-touch-event.md | 5 + .../on-window-focus-changed.md | 5 + .../original-text.md | 10 + .../send-accessibility-event-unchecked.md | 5 + .../set-on-commit-listener.md | 5 + .../set-on-filter-listener.md | 5 + .../set-on-key-pre-ime-listener.md | 5 + .../set-on-search-state-change-listener.md | 5 + .../set-on-selection-changed-listener.md | 5 + .../set-on-text-change-listener.md | 5 + .../set-on-windows-focus-change-listener.md | 5 + .../set-text.md | 5 + .../-on-commit-listener.md | 5 + .../-on-filter-listener.md | 11 + .../-on-key-pre-ime-listener.md | 5 + .../-on-search-state-change-listener.md | 5 + .../-on-selection-changed-listener.md | 5 + .../-on-text-change-listener.md | 5 + .../-on-windows-focus-change-listener.md | 5 + .../-text-formatter.md | 5 + .../index.md | 23 + .../-doorhanger/-init-.md | 9 + .../-doorhanger/dismiss.md | 8 + .../-doorhanger/index.md | 21 + .../-doorhanger/show.md | 8 + .../mozilla.components.ui.doorhanger/index.md | 9 + .../-animated-progress-bar/-init-.md | 8 + .../-animated-progress-bar/index.md | 39 ++ .../-animated-progress-bar/on-draw.md | 5 + .../-animated-progress-bar/set-progress.md | 8 + .../-animated-progress-bar/set-visibility.md | 8 + .../mozilla.components.ui.progress/index.md | 9 + .../-tab-counter/-init-.md | 5 + .../-tab-counter/get-text.md | 5 + .../-tab-counter/index.md | 38 ++ .../-tab-counter/set-count-with-animation.md | 5 + .../-tab-counter/set-count.md | 5 + .../mozilla.components.ui.tabcounter/index.md | 9 + .../-telemetry-configuration/-init-.md | 5 + .../-telemetry-configuration/get-app-name.md | 8 + .../get-app-version.md | 8 + .../-telemetry-configuration/get-build-id.md | 8 + .../get-class-load-timestamp-millis.md | 5 + .../get-connect-timeout.md | 8 + .../-telemetry-configuration/get-context.md | 8 + .../get-data-directory.md | 8 + .../get-initial-backoff-for-upload.md | 8 + .../get-maximum-number-of-events-per-ping.md | 8 + ...-maximum-number-of-ping-uploads-per-day.md | 8 + .../get-maximum-number-of-pings-per-type.md | 8 + .../get-minimum-events-for-upload.md | 8 + ...get-preferences-important-for-telemetry.md | 8 + .../get-read-timeout.md | 8 + .../get-server-endpoint.md | 8 + .../get-settings-provider.md | 8 + .../get-shared-preferences.md | 8 + .../get-update-channel.md | 8 + .../get-user-agent.md | 8 + .../-telemetry-configuration/index.md | 57 +++ .../is-collection-enabled.md | 8 + .../is-upload-enabled.md | 8 + .../-telemetry-configuration/set-app-name.md | 8 + .../set-app-version.md | 8 + .../-telemetry-configuration/set-build-id.md | 8 + .../set-collection-enabled.md | 8 + .../set-connect-timeout.md | 8 + .../set-data-directory.md | 8 + .../set-initial-backoff-for-upload.md | 8 + .../set-maximum-number-of-events-per-ping.md | 8 + ...-maximum-number-of-ping-uploads-per-day.md | 8 + .../set-maximum-number-of-pings-per-type.md | 8 + .../set-minimum-events-for-upload.md | 8 + ...set-preferences-important-for-telemetry.md | 8 + .../set-read-timeout.md | 8 + .../set-server-endpoint.md | 8 + .../set-settings-provider.md | 8 + .../set-update-channel.md | 8 + .../set-upload-enabled.md | 8 + .../set-user-agent.md | 8 + .../api/org.mozilla.telemetry.config/index.md | 9 + .../-telemetry-event/create.md | 27 ++ .../-telemetry-event/extra.md | 5 + .../-telemetry-event/index.md | 16 + .../-telemetry-event/queue.md | 8 + .../-telemetry-event/to-j-s-o-n.md | 8 + docs/api/org.mozilla.telemetry.event/index.md | 9 + .../-arch-measurement/-init-.md | 5 + .../-arch-measurement/flush.md | 8 + .../-arch-measurement/index.md | 23 + .../-client-id-measurement/-init-.md | 5 + .../-client-id-measurement/flush.md | 8 + .../-client-id-measurement/index.md | 25 ++ .../-created-date-measurement-new/-init-.md | 5 + .../-created-date-measurement-new/flush.md | 8 + .../-created-date-measurement-new/index.md | 25 ++ .../-created-date-measurement/-init-.md | 5 + .../-created-date-measurement/flush.md | 8 + .../-created-date-measurement/index.md | 23 + .../-init-.md | 5 + .../flush.md | 8 + .../index.md | 25 ++ .../-created-timestamp-measurement/-init-.md | 5 + .../-created-timestamp-measurement/flush.md | 8 + .../-created-timestamp-measurement/index.md | 23 + .../get-default-search-engine-identifier.md | 5 + .../-default-search-engine-provider/index.md | 11 + .../-default-search-measurement/-init-.md | 5 + .../-default-search-measurement/flush.md | 8 + .../-default-search-measurement/index.md | 30 ++ .../set-default-search-engine-provider.md | 5 + .../-device-measurement/-init-.md | 5 + .../-device-measurement/flush.md | 8 + .../-device-measurement/index.md | 23 + .../-events-measurement/-init-.md | 6 + .../-events-measurement/add.md | 5 + .../-events-measurement/flush.md | 8 + .../-events-measurement/get-event-count.md | 5 + .../-events-measurement/index.md | 25 ++ .../-experiments-map-measurement/-init-.md | 5 + .../-experiments-map-measurement/flush.md | 8 + .../-experiments-map-measurement/index.md | 24 ++ .../set-experiments.md | 5 + .../-experiments-measurement/-init-.md | 5 + .../-experiments-measurement/flush.md | 8 + .../-experiments-measurement/index.md | 24 ++ .../set-active-experiments.md | 5 + .../-init-.md | 5 + .../flush.md | 8 + .../index.md | 25 ++ .../-locale-measurement/-init-.md | 5 + .../-locale-measurement/flush.md | 8 + .../-locale-measurement/get-language-tag.md | 11 + .../-locale-measurement/index.md | 24 ++ .../-metrics-measurement/-init-.md | 5 + .../-metrics-measurement/flush.md | 8 + .../-metrics-measurement/index.md | 23 + .../-operating-system-measurement/-init-.md | 5 + .../-operating-system-measurement/index.md | 17 + .../-init-.md | 5 + .../index.md | 17 + .../-pocket-id-measurement/-init-.md | 5 + .../-pocket-id-measurement/flush.md | 8 + .../-pocket-id-measurement/index.md | 25 ++ .../-init-.md | 5 + .../flush.md | 8 + .../index.md | 23 + .../-searches-measurement/-init-.md | 5 + .../-l-o-c-a-t-i-o-n_-a-c-t-i-o-n-b-a-r.md | 5 + .../-l-o-c-a-t-i-o-n_-l-i-s-t-i-t-e-m.md | 5 + .../-l-o-c-a-t-i-o-n_-s-u-g-g-e-s-t-i-o-n.md | 5 + .../-searches-measurement/flush.md | 8 + .../-searches-measurement/index.md | 34 ++ .../-searches-measurement/record-search.md | 13 + .../-sequence-measurement/-init-.md | 5 + .../-sequence-measurement/flush.md | 8 + .../-sequence-measurement/index.md | 23 + .../-session-count-measurement/-init-.md | 5 + .../count-session.md | 5 + .../-session-count-measurement/flush.md | 8 + .../-session-count-measurement/index.md | 24 ++ .../-session-duration-measurement/-init-.md | 5 + .../-session-duration-measurement/flush.md | 8 + .../-session-duration-measurement/index.md | 25 ++ .../record-session-end.md | 5 + .../record-session-start.md | 5 + .../-settings-measurement/-init-.md | 5 + .../-settings-provider/contains-key.md | 8 + .../-settings-provider/get-value.md | 8 + .../-settings-provider/index.md | 22 + .../-settings-provider/release.md | 8 + .../-settings-provider/update.md | 8 + .../-init-.md | 8 + .../contains-key.md | 8 + .../get-value.md | 8 + .../index.md | 22 + .../release.md | 8 + .../update.md | 8 + .../-settings-measurement/flush.md | 8 + .../-settings-measurement/index.md | 30 ++ .../-static-measurement/-init-.md | 5 + .../-static-measurement/flush.md | 8 + .../-static-measurement/index.md | 31 ++ .../-telemetry-measurement/-init-.md | 5 + .../-telemetry-measurement/flush.md | 8 + .../-telemetry-measurement/get-field-name.md | 5 + .../-telemetry-measurement/index.md | 46 ++ .../-timezone-offset-measurement/-init-.md | 5 + .../-timezone-offset-measurement/flush.md | 8 + .../-timezone-offset-measurement/index.md | 23 + .../-version-measurement/-init-.md | 5 + .../-version-measurement/index.md | 17 + .../index.md | 35 ++ .../-telemetry-client/-init-.md | 5 + .../-telemetry-client/index.md | 17 + .../-telemetry-client/upload-ping.md | 5 + docs/api/org.mozilla.telemetry.net/index.md | 9 + .../-telemetry-core-ping-builder/-init-.md | 5 + .../-telemetry-core-ping-builder/-t-y-p-e.md | 5 + .../get-default-search-measurement.md | 5 + .../get-experiments-measurement.md | 5 + .../get-searches-measurement.md | 5 + .../get-session-count-measurement.md | 5 + .../get-session-duration-measurement.md | 5 + .../-telemetry-core-ping-builder/index.md | 39 ++ .../-telemetry-event-ping-builder/-init-.md | 5 + .../-telemetry-event-ping-builder/-t-y-p-e.md | 5 + .../can-build.md | 8 + .../get-events-measurement.md | 5 + .../get-experiments-map-measurement.md | 5 + .../-telemetry-event-ping-builder/index.md | 36 ++ .../-init-.md | 5 + .../-t-y-p-e.md | 5 + .../can-build.md | 8 + .../get-events-measurement.md | 5 + .../get-experiments-map-measurement.md | 5 + .../index.md | 36 ++ .../-init-.md | 5 + .../-t-y-p-e.md | 5 + .../index.md | 29 ++ .../-telemetry-ping-builder/-init-.md | 5 + .../-telemetry-ping-builder/build.md | 5 + .../-telemetry-ping-builder/can-build.md | 5 + .../generate-document-id.md | 5 + .../get-configuration.md | 5 + .../-telemetry-ping-builder/get-type.md | 5 + .../-telemetry-ping-builder/index.md | 31 ++ .../-telemetry-ping/get-document-id.md | 5 + .../get-measurement-results.md | 5 + .../-telemetry-ping/get-type.md | 5 + .../-telemetry-ping/get-upload-path.md | 5 + .../-telemetry-ping/index.md | 14 + .../-init-.md | 5 + .../-t-y-p-e.md | 5 + .../get-events-measurement.md | 5 + .../index.md | 35 ++ docs/api/org.mozilla.telemetry.ping/index.md | 15 + .../-init-.md | 6 + .../index.md | 19 + .../schedule-upload.md | 8 + .../-telemetry-job-service/-init-.md | 5 + .../-telemetry-job-service/index.md | 19 + .../-telemetry-job-service/on-start-job.md | 5 + .../-telemetry-job-service/on-stop-job.md | 5 + .../upload-pings-in-background.md | 5 + .../index.md | 10 + .../-telemetry-scheduler/index.md | 17 + .../-telemetry-scheduler/schedule-upload.md | 5 + .../org.mozilla.telemetry.schedule/index.md | 9 + .../-j-s-o-n-ping-serializer/-init-.md | 8 + .../-j-s-o-n-ping-serializer/index.md | 19 + .../-j-s-o-n-ping-serializer/serialize.md | 8 + .../-telemetry-ping-serializer/index.md | 17 + .../-telemetry-ping-serializer/serialize.md | 5 + .../org.mozilla.telemetry.serialize/index.md | 10 + .../-file-telemetry-storage/-init-.md | 5 + .../count-stored-pings.md | 8 + .../-file-telemetry-storage/index.md | 21 + .../-file-telemetry-storage/process.md | 8 + .../-file-telemetry-storage/store.md | 8 + .../-telemetry-storage-callback/index.md | 11 + .../on-telemetry-ping-loaded.md | 5 + .../-telemetry-storage/count-stored-pings.md | 5 + .../-telemetry-storage/index.md | 25 ++ .../-telemetry-storage/process.md | 5 + .../-telemetry-storage/store.md | 5 + .../org.mozilla.telemetry.storage/index.md | 10 + .../-context-utils/-init-.md | 5 + .../-context-utils/get-app-name.md | 5 + .../-context-utils/get-version-code.md | 5 + .../-context-utils/get-version-name.md | 5 + .../-context-utils/index.md | 19 + .../-file-last-modified-comparator/-init-.md | 5 + .../-file-last-modified-comparator/compare.md | 5 + .../-file-last-modified-comparator/index.md | 17 + .../-filename-regex-filter/-init-.md | 5 + .../-filename-regex-filter/accept.md | 5 + .../-filename-regex-filter/index.md | 17 + .../-file-utils/-init-.md | 5 + .../-file-utils/assert-directory.md | 5 + .../-file-utils/index.md | 24 ++ .../-i-o-utils/-init-.md | 5 + .../-i-o-utils/index.md | 17 + .../-i-o-utils/safe-close.md | 5 + .../-string-utils/-init-.md | 5 + .../-string-utils/index.md | 17 + .../-string-utils/safe-substring.md | 5 + docs/api/org.mozilla.telemetry.util/index.md | 12 + .../-telemetry-holder/-init-.md | 8 + .../-telemetry-holder/get.md | 5 + .../-telemetry-holder/index.md | 20 + .../-telemetry-holder/set.md | 5 + .../-telemetry/-init-.md | 5 + .../-telemetry/add-ping-builder.md | 5 + .../-telemetry/get-builders.md | 5 + .../-telemetry/get-client-id.md | 8 + .../-telemetry/get-client.md | 5 + .../-telemetry/get-configuration.md | 5 + .../-telemetry/get-ping-builder.md | 8 + .../-telemetry/get-storage.md | 5 + .../org.mozilla.telemetry/-telemetry/index.md | 32 ++ .../-telemetry/queue-event.md | 5 + .../-telemetry/queue-ping.md | 5 + .../-telemetry/record-active-experiments.md | 11 + .../-telemetry/record-experiments.md | 11 + .../-telemetry/record-search.md | 13 + .../-telemetry/record-session-end.md | 6 + .../-telemetry/record-session-start.md | 5 + .../-telemetry/schedule-upload.md | 5 + .../-telemetry/set-default-search-provider.md | 5 + docs/api/org.mozilla.telemetry/index.md | 10 + docs/api/package-list | 176 ++++++++ 2912 files changed, 35740 insertions(+) create mode 100644 docs/api/alltypes/index.md create mode 100644 docs/api/index.md create mode 100644 docs/api/mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/-init-.md create mode 100644 docs/api/mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/create-view-holder.md create mode 100644 docs/api/mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/get-layout-resource.md create mode 100644 docs/api/mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/index.md create mode 100644 docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-layout/create-view-holder.md create mode 100644 docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-layout/get-layout-resource.md create mode 100644 docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-layout/index.md create mode 100644 docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-view-holder/-init-.md create mode 100644 docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-view-holder/bind.md create mode 100644 docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-view-holder/index.md create mode 100644 docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-view-holder/view.md create mode 100644 docs/api/mozilla.components.browser.awesomebar.layout/index.md create mode 100644 docs/api/mozilla.components.browser.awesomebar.transform/-suggestion-transformer/index.md create mode 100644 docs/api/mozilla.components.browser.awesomebar.transform/-suggestion-transformer/transform.md create mode 100644 docs/api/mozilla.components.browser.awesomebar.transform/index.md create mode 100644 docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/-init-.md create mode 100644 docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/add-providers.md create mode 100644 docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md create mode 100644 docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/layout.md create mode 100644 docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/on-detached-from-window.md create mode 100644 docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/on-input-cancelled.md create mode 100644 docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/on-input-changed.md create mode 100644 docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/on-input-started.md create mode 100644 docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/set-on-stop-listener.md create mode 100644 docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/transformer.md create mode 100644 docs/api/mozilla.components.browser.awesomebar/index.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/-init-.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/domains.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/get-autocomplete-suggestion.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/index.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/initialize.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-custom-domains-provider/-init-.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-custom-domains-provider/index.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-custom-domains-provider/initialize.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-provider/get-autocomplete-suggestion.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-provider/index.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/-init-.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/index.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/input.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/source.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/text.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/total-items.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/url.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-domain-list/-c-u-s-t-o-m.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-domain-list/-d-e-f-a-u-l-t.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-domain-list/index.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-domain-list/list-name.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-shipped-domains-provider/-init-.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-shipped-domains-provider/index.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/-shipped-domains-provider/initialize.md create mode 100644 docs/api/mozilla.components.browser.domains.autocomplete/index.md create mode 100644 docs/api/mozilla.components.browser.domains/-custom-domains/add.md create mode 100644 docs/api/mozilla.components.browser.domains/-custom-domains/index.md create mode 100644 docs/api/mozilla.components.browser.domains/-custom-domains/load.md create mode 100644 docs/api/mozilla.components.browser.domains/-custom-domains/remove.md create mode 100644 docs/api/mozilla.components.browser.domains/-custom-domains/save.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-autocomplete-source/-c-u-s-t-o-m_-l-i-s-t.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-autocomplete-source/-d-e-f-a-u-l-t_-l-i-s-t.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-autocomplete-source/index.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-init-.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/-init-.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/index.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/size.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/source.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/text.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/url.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/autocomplete.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/index.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/initialize.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain/-init-.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain/create.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain/has-www.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain/host.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain/index.md create mode 100644 docs/api/mozilla.components.browser.domains/-domain/protocol.md create mode 100644 docs/api/mozilla.components.browser.domains/-domains/index.md create mode 100644 docs/api/mozilla.components.browser.domains/-domains/load.md create mode 100644 docs/api/mozilla.components.browser.domains/index.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.fetch/-byte-buffer-input-stream/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.fetch/-byte-buffer-input-stream/index.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.fetch/-byte-buffer-input-stream/read.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/-m-a-x_-r-e-a-d_-t-i-m-e-o-u-t_-m-i-n-u-t-e-s.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/fetch.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/index.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.fetch/index.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-app/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-app/index.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-app/permissions-map.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-app/uri.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-content/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-content/index.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-content/permissions-map.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-content/uri.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/contains-video-and-audio-sources.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/grant.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/index.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/map-permission.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/reject.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/uri.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/grant.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/index.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/permissions.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/reject.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.permission/index.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.prompt/-gecko-choice.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko.prompt/index.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session-state/from-j-s-o-n.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session-state/index.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session-state/to-j-s-o-n.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/capture-thumbnail.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/clear-data.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/clear-find-matches.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/close.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/coroutine-context.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/disable-tracking-protection.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/enable-tracking-protection.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/exit-full-screen-mode.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-all.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-next.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-back.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-forward.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/handle-long-click.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/index.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-data.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-url.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/reload.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/restore-state.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/save-state.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/settings.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/stop-loading.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/toggle-desktop-mode.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-view/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-view/can-scroll-vertically-down.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-view/index.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-view/render.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/create-session-state.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/create-session.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/create-view.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/index.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/name.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/settings.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/speculative-connect.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/dispatch-nested-fling.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/dispatch-nested-pre-fling.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/dispatch-nested-pre-scroll.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/dispatch-nested-scroll.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/has-nested-scrolling-parent.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/index.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/is-nested-scrolling-enabled.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/on-touch-event.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/set-nested-scrolling-enabled.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/start-nested-scroll.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/stop-nested-scroll.md create mode 100644 docs/api/mozilla.components.browser.engine.gecko/index.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session-state/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session-state/from-j-s-o-n.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session-state/index.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session-state/to-j-s-o-n.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/capture-thumbnail.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/clear-data.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/clear-find-matches.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/disable-tracking-protection.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/enable-tracking-protection.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/exit-full-screen-mode.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/find-all.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/find-next.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/go-back.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/go-forward.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/index.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/load-data.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/load-url.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/reload.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/restore-state.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/save-state.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/settings.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/stop-loading.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/toggle-desktop-mode.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/index.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/on-pause.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/on-resume.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/render.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine/create-session-state.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine/create-session.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine/create-view.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine/index.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine/name.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine/settings.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/-servo-engine/speculative-connect.md create mode 100644 docs/api/mozilla.components.browser.engine.servo/index.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/char-at.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/create.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/index.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/is-reversed.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/length.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/offset-end.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/offset-start.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/reverse.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/string.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/substring.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-trie/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-trie/children.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-trie/create-node.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-trie/create-root-node.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-trie/find-node.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-trie/index.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-trie/put.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-a-d-v-e-r-t-i-s-i-n-g.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-a-n-a-l-y-t-i-c-s.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-c-o-n-t-e-n-t.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-d-e-f-a-u-l-t.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-d-i-s-c-o-n-n-e-c-t.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-s-o-c-i-a-l.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/create-matcher.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/index.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/is-web-font.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/matches.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/set-categories-enabled.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/index.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/kotlin.-string/index.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/kotlin.-string/reverse.md create mode 100644 docs/api/mozilla.components.browser.engine.system.matcher/kotlin.-string/reversible.md create mode 100644 docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/grant.md create mode 100644 docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/index.md create mode 100644 docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/permissions-map.md create mode 100644 docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/permissions.md create mode 100644 docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/reject.md create mode 100644 docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/uri.md create mode 100644 docs/api/mozilla.components.browser.engine.system.permission/index.md create mode 100644 docs/api/mozilla.components.browser.engine.system.window/-system-window-request/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.system.window/-system-window-request/index.md create mode 100644 docs/api/mozilla.components.browser.engine.system.window/-system-window-request/open-as-dialog.md create mode 100644 docs/api/mozilla.components.browser.engine.system.window/-system-window-request/prepare.md create mode 100644 docs/api/mozilla.components.browser.engine.system.window/-system-window-request/start.md create mode 100644 docs/api/mozilla.components.browser.engine.system.window/-system-window-request/triggered-by-user.md create mode 100644 docs/api/mozilla.components.browser.engine.system.window/-system-window-request/url.md create mode 100644 docs/api/mozilla.components.browser.engine.system.window/index.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-nested-web-view/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-nested-web-view/dispatch-nested-fling.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-nested-web-view/dispatch-nested-pre-fling.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-nested-web-view/dispatch-nested-pre-scroll.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-nested-web-view/dispatch-nested-scroll.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-nested-web-view/has-nested-scrolling-parent.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-nested-web-view/index.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-nested-web-view/is-nested-scrolling-enabled.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-nested-web-view/on-touch-event.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-nested-web-view/set-nested-scrolling-enabled.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-nested-web-view/start-nested-scroll.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-nested-web-view/stop-nested-scroll.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session-state/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session-state/from-j-s-o-n.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session-state/index.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session-state/to-j-s-o-n.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/-web-setting/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/-web-setting/get-value.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/-web-setting/index.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/-web-setting/set-value.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/capture-thumbnail.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/clear-data.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/clear-find-matches.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/close.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/disable-tracking-protection.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/enable-tracking-protection.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/exit-full-screen-mode.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/find-all.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/find-next.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/go-back.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/go-forward.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/index.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/load-data.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/load-url.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/reload.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/restore-state.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/save-state.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/settings.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/stop-loading.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/toggle-desktop-mode.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-session/web-view.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/handle-message.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/index.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/session.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-view/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-view/can-scroll-vertically-down.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-view/index.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-view/on-destroy.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-view/on-long-click.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-view/on-pause.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-view/on-resume.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine-view/render.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine/-init-.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine/create-session-state.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine/create-session.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine/create-view.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine/default-user-agent.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine/index.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine/name.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine/settings.md create mode 100644 docs/api/mozilla.components.browser.engine.system/-system-engine/speculative-connect.md create mode 100644 docs/api/mozilla.components.browser.engine.system/index.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-pages/create-error-page.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-pages/index.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-c-o-n-n-e-c-t-i-o-n_-r-e-f-u-s-e-d.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-c-o-n-t-e-n-t_-c-r-a-s-h-e-d.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-c-o-r-r-u-p-t-e-d_-c-o-n-t-e-n-t.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-f-i-l-e_-a-c-c-e-s-s_-d-e-n-i-e-d.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-f-i-l-e_-n-o-t_-f-o-u-n-d.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-i-n-v-a-l-i-d_-c-o-n-t-e-n-t_-e-n-c-o-d-i-n-g.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-m-a-l-f-o-r-m-e-d_-u-r-i.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-n-e-t_-i-n-t-e-r-r-u-p-t.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-n-e-t_-r-e-s-e-t.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-n-e-t_-t-i-m-e-o-u-t.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-o-f-f-l-i-n-e.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-p-o-r-t_-b-l-o-c-k-e-d.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-p-r-o-x-y_-c-o-n-n-e-c-t-i-o-n_-r-e-f-u-s-e-d.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-r-e-d-i-r-e-c-t_-l-o-o-p.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-h-a-r-m-f-u-l_-u-r-i.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-m-a-l-w-a-r-e_-u-r-i.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-p-h-i-s-h-i-n-g_-u-r-i.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-u-n-w-a-n-t-e-d_-u-r-i.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-e-c-u-r-i-t-y_-b-a-d_-c-e-r-t.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-e-c-u-r-i-t-y_-s-s-l.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-k-n-o-w-n_-h-o-s-t.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-k-n-o-w-n_-p-r-o-t-o-c-o-l.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-k-n-o-w-n_-p-r-o-x-y_-h-o-s-t.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-k-n-o-w-n_-s-o-c-k-e-t_-t-y-p-e.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-s-a-f-e_-c-o-n-t-e-n-t_-t-y-p-e.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/-u-n-k-n-o-w-n.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/index.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/message-res.md create mode 100644 docs/api/mozilla.components.browser.errorpages/-error-type/title-res.md create mode 100644 docs/api/mozilla.components.browser.errorpages/index.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-checkbox/-init-.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-checkbox/get-layout-resource.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-checkbox/index.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-compound-button/-init-.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-compound-button/bind.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-compound-button/index.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-compound-button/visible.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/-init-.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/bind.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/get-layout-resource.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/index.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/visible.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/-init-.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/bind.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/get-layout-resource.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/index.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/visible.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/-init-.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/content-description.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/icon-tint-color-resource.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/image-resource.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/index.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/listener.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-init-.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/bind.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/get-layout-resource.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/index.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/visible.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-switch/-init-.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-switch/get-layout-resource.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-browser-menu-switch/index.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/-init-.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/bind.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/get-layout-resource.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/index.md create mode 100644 docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/visible.md create mode 100644 docs/api/mozilla.components.browser.menu.item/index.md create mode 100644 docs/api/mozilla.components.browser.menu/-browser-menu-builder/-init-.md create mode 100644 docs/api/mozilla.components.browser.menu/-browser-menu-builder/build.md create mode 100644 docs/api/mozilla.components.browser.menu/-browser-menu-builder/index.md create mode 100644 docs/api/mozilla.components.browser.menu/-browser-menu-builder/items.md create mode 100644 docs/api/mozilla.components.browser.menu/-browser-menu-item-view-holder/-init-.md create mode 100644 docs/api/mozilla.components.browser.menu/-browser-menu-item-view-holder/index.md create mode 100644 docs/api/mozilla.components.browser.menu/-browser-menu-item/bind.md create mode 100644 docs/api/mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md create mode 100644 docs/api/mozilla.components.browser.menu/-browser-menu-item/index.md create mode 100644 docs/api/mozilla.components.browser.menu/-browser-menu-item/visible.md create mode 100644 docs/api/mozilla.components.browser.menu/-browser-menu/-orientation/-d-o-w-n.md create mode 100644 docs/api/mozilla.components.browser.menu/-browser-menu/-orientation/-u-p.md create mode 100644 docs/api/mozilla.components.browser.menu/-browser-menu/-orientation/index.md create mode 100644 docs/api/mozilla.components.browser.menu/-browser-menu/determine-menu-orientation.md create mode 100644 docs/api/mozilla.components.browser.menu/-browser-menu/dismiss.md create mode 100644 docs/api/mozilla.components.browser.menu/-browser-menu/index.md create mode 100644 docs/api/mozilla.components.browser.menu/-browser-menu/show.md create mode 100644 docs/api/mozilla.components.browser.menu/index.md create mode 100644 docs/api/mozilla.components.browser.search.provider.filter/-search-engine-filter/filter.md create mode 100644 docs/api/mozilla.components.browser.search.provider.filter/-search-engine-filter/index.md create mode 100644 docs/api/mozilla.components.browser.search.provider.filter/index.md create mode 100644 docs/api/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/-init-.md create mode 100644 docs/api/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/country.md create mode 100644 docs/api/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/index.md create mode 100644 docs/api/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/language.md create mode 100644 docs/api/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/region.md create mode 100644 docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/-init-.md create mode 100644 docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/country.md create mode 100644 docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/index.md create mode 100644 docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/language-tag.md create mode 100644 docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/language.md create mode 100644 docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/region.md create mode 100644 docs/api/mozilla.components.browser.search.provider.localization/index.md create mode 100644 docs/api/mozilla.components.browser.search.provider/-assets-search-engine-provider/-init-.md create mode 100644 docs/api/mozilla.components.browser.search.provider/-assets-search-engine-provider/index.md create mode 100644 docs/api/mozilla.components.browser.search.provider/-assets-search-engine-provider/load-search-engines.md create mode 100644 docs/api/mozilla.components.browser.search.provider/-search-engine-provider/index.md create mode 100644 docs/api/mozilla.components.browser.search.provider/-search-engine-provider/load-search-engines.md create mode 100644 docs/api/mozilla.components.browser.search.provider/index.md create mode 100644 docs/api/mozilla.components.browser.search.suggestions/-j-s-o-n-response.md create mode 100644 docs/api/mozilla.components.browser.search.suggestions/-response-parser.md create mode 100644 docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-fetch-exception/-init-.md create mode 100644 docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-fetch-exception/index.md create mode 100644 docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-init-.md create mode 100644 docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-response-parser-exception/-init-.md create mode 100644 docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-response-parser-exception/index.md create mode 100644 docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/get-suggestions.md create mode 100644 docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/index.md create mode 100644 docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-fetcher.md create mode 100644 docs/api/mozilla.components.browser.search.suggestions/index.md create mode 100644 docs/api/mozilla.components.browser.search/-search-engine-manager/-init-.md create mode 100644 docs/api/mozilla.components.browser.search/-search-engine-manager/get-default-search-engine.md create mode 100644 docs/api/mozilla.components.browser.search/-search-engine-manager/get-search-engines.md create mode 100644 docs/api/mozilla.components.browser.search/-search-engine-manager/index.md create mode 100644 docs/api/mozilla.components.browser.search/-search-engine-manager/load.md create mode 100644 docs/api/mozilla.components.browser.search/-search-engine-manager/register-for-locale-updates.md create mode 100644 docs/api/mozilla.components.browser.search/-search-engine-parser/-init-.md create mode 100644 docs/api/mozilla.components.browser.search/-search-engine-parser/index.md create mode 100644 docs/api/mozilla.components.browser.search/-search-engine-parser/load.md create mode 100644 docs/api/mozilla.components.browser.search/-search-engine/build-search-url.md create mode 100644 docs/api/mozilla.components.browser.search/-search-engine/build-suggestions-u-r-l.md create mode 100644 docs/api/mozilla.components.browser.search/-search-engine/can-provide-search-suggestions.md create mode 100644 docs/api/mozilla.components.browser.search/-search-engine/icon.md create mode 100644 docs/api/mozilla.components.browser.search/-search-engine/identifier.md create mode 100644 docs/api/mozilla.components.browser.search/-search-engine/index.md create mode 100644 docs/api/mozilla.components.browser.search/-search-engine/name.md create mode 100644 docs/api/mozilla.components.browser.search/index.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-auto-save/-d-e-f-a-u-l-t_-i-n-t-e-r-v-a-l_-m-i-l-l-i-s-e-c-o-n-d-s.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-auto-save/-init-.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-auto-save/-storage/index.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-auto-save/-storage/save.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-auto-save/index.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-auto-save/periodically-in-foreground.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-auto-save/when-going-to-background.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-auto-save/when-sessions-change.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-session-storage/-init-.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-session-storage/auto-save.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-session-storage/clear.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-session-storage/index.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-session-storage/restore.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-session-storage/save.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-snapshot-serializer/-init-.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-snapshot-serializer/from-j-s-o-n.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-snapshot-serializer/index.md create mode 100644 docs/api/mozilla.components.browser.session.storage/-snapshot-serializer/to-j-s-o-n.md create mode 100644 docs/api/mozilla.components.browser.session.storage/index.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/-init-.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/description.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/icon.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/index.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/pending-intent.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-config/action-button-config.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-config/close-button-icon.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-config/create-from-intent.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-config/disable-urlbar-hiding.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-config/id.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-config/index.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-config/is-custom-tab-intent.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-config/menu-items.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-config/options.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-config/show-share-menu-item.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-config/toolbar-color.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-menu-item/-init-.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-menu-item/index.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-menu-item/name.md create mode 100644 docs/api/mozilla.components.browser.session.tab/-custom-tab-menu-item/pending-intent.md create mode 100644 docs/api/mozilla.components.browser.session.tab/index.md create mode 100644 docs/api/mozilla.components.browser.session/-download/-init-.md create mode 100644 docs/api/mozilla.components.browser.session/-download/content-length.md create mode 100644 docs/api/mozilla.components.browser.session/-download/content-type.md create mode 100644 docs/api/mozilla.components.browser.session/-download/destination-directory.md create mode 100644 docs/api/mozilla.components.browser.session/-download/file-name.md create mode 100644 docs/api/mozilla.components.browser.session/-download/index.md create mode 100644 docs/api/mozilla.components.browser.session/-download/url.md create mode 100644 docs/api/mozilla.components.browser.session/-download/user-agent.md create mode 100644 docs/api/mozilla.components.browser.session/-selection-aware-session-observer/-init-.md create mode 100644 docs/api/mozilla.components.browser.session/-selection-aware-session-observer/active-session.md create mode 100644 docs/api/mozilla.components.browser.session/-selection-aware-session-observer/index.md create mode 100644 docs/api/mozilla.components.browser.session/-selection-aware-session-observer/observe-fixed.md create mode 100644 docs/api/mozilla.components.browser.session/-selection-aware-session-observer/observe-selected.md create mode 100644 docs/api/mozilla.components.browser.session/-selection-aware-session-observer/on-session-selected.md create mode 100644 docs/api/mozilla.components.browser.session/-selection-aware-session-observer/stop.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-init-.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-n-o_-s-e-l-e-c-t-i-o-n.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-observer/index.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-observer/on-all-sessions-removed.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-observer/on-session-added.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-observer/on-session-removed.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-observer/on-session-selected.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-observer/on-sessions-restored.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-init-.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/-init-.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/engine-session-state.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/engine-session.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/index.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/session.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-snapshot/index.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-snapshot/is-empty.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-snapshot/selected-session-index.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/-snapshot/sessions.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/add.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/all.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/create-snapshot.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/default-session.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/engine.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/find-session-by-id.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/get-engine-session.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/get-or-create-engine-session.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/index.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/on-low-memory.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/remove-all.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/remove-sessions.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/remove.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/restore.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/select.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/selected-session-or-throw.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/selected-session.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/sessions.md create mode 100644 docs/api/mozilla.components.browser.session/-session-manager/size.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-find-result/-init-.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-find-result/active-match-ordinal.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-find-result/index.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-find-result/is-done-counting.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-find-result/number-of-matches.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-init-.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/index.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-app-permission-requested.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-close-window-requested.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-content-permission-requested.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-custom-tab-config-changed.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-desktop-mode-changed.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-download.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-find-result.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-full-screen-changed.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-loading-state-changed.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-long-press.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-navigation-state-changed.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-open-window-requested.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-progress.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-prompt-requested.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-search.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-security-changed.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-thumbnail-changed.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-title-changed.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-tracker-blocked.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-tracker-blocking-enabled-changed.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-observer/on-url-changed.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-security-info/-init-.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-security-info/host.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-security-info/index.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-security-info/issuer.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-security-info/secure.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-source/-a-c-t-i-o-n_-s-e-n-d.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-source/-a-c-t-i-o-n_-v-i-e-w.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-source/-c-u-s-t-o-m_-t-a-b.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-source/-h-o-m-e_-s-c-r-e-e-n.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-source/-m-e-n-u.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-source/-n-e-w_-t-a-b.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-source/-n-o-n-e.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-source/-t-e-x-t_-s-e-l-e-c-t-i-o-n.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-source/-u-s-e-r_-e-n-t-e-r-e-d.md create mode 100644 docs/api/mozilla.components.browser.session/-session/-source/index.md create mode 100644 docs/api/mozilla.components.browser.session/-session/app-permission-request.md create mode 100644 docs/api/mozilla.components.browser.session/-session/can-go-back.md create mode 100644 docs/api/mozilla.components.browser.session/-session/can-go-forward.md create mode 100644 docs/api/mozilla.components.browser.session/-session/close-window-request.md create mode 100644 docs/api/mozilla.components.browser.session/-session/content-permission-request.md create mode 100644 docs/api/mozilla.components.browser.session/-session/custom-tab-config.md create mode 100644 docs/api/mozilla.components.browser.session/-session/desktop-mode.md create mode 100644 docs/api/mozilla.components.browser.session/-session/download.md create mode 100644 docs/api/mozilla.components.browser.session/-session/equals.md create mode 100644 docs/api/mozilla.components.browser.session/-session/find-results.md create mode 100644 docs/api/mozilla.components.browser.session/-session/full-screen-mode.md create mode 100644 docs/api/mozilla.components.browser.session/-session/hash-code.md create mode 100644 docs/api/mozilla.components.browser.session/-session/hit-result.md create mode 100644 docs/api/mozilla.components.browser.session/-session/id.md create mode 100644 docs/api/mozilla.components.browser.session/-session/index.md create mode 100644 docs/api/mozilla.components.browser.session/-session/is-custom-tab-session.md create mode 100644 docs/api/mozilla.components.browser.session/-session/loading.md create mode 100644 docs/api/mozilla.components.browser.session/-session/open-window-request.md create mode 100644 docs/api/mozilla.components.browser.session/-session/private.md create mode 100644 docs/api/mozilla.components.browser.session/-session/progress.md create mode 100644 docs/api/mozilla.components.browser.session/-session/prompt-request.md create mode 100644 docs/api/mozilla.components.browser.session/-session/search-terms.md create mode 100644 docs/api/mozilla.components.browser.session/-session/security-info.md create mode 100644 docs/api/mozilla.components.browser.session/-session/source.md create mode 100644 docs/api/mozilla.components.browser.session/-session/thumbnail.md create mode 100644 docs/api/mozilla.components.browser.session/-session/title.md create mode 100644 docs/api/mozilla.components.browser.session/-session/to-string.md create mode 100644 docs/api/mozilla.components.browser.session/-session/tracker-blocking-enabled.md create mode 100644 docs/api/mozilla.components.browser.session/-session/trackers-blocked.md create mode 100644 docs/api/mozilla.components.browser.session/-session/url.md create mode 100644 docs/api/mozilla.components.browser.session/index.md create mode 100644 docs/api/mozilla.components.browser.session/run-with-session.md create mode 100644 docs/api/mozilla.components.browser.storage.memory/-a-u-t-o-c-o-m-p-l-e-t-e_-s-o-u-r-c-e_-n-a-m-e.md create mode 100644 docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/-init-.md create mode 100644 docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/cleanup.md create mode 100644 docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/get-autocomplete-suggestion.md create mode 100644 docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/get-suggestions.md create mode 100644 docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/get-visited.md create mode 100644 docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/index.md create mode 100644 docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/record-observation.md create mode 100644 docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/record-visit.md create mode 100644 docs/api/mozilla.components.browser.storage.memory/-visit/-init-.md create mode 100644 docs/api/mozilla.components.browser.storage.memory/-visit/index.md create mode 100644 docs/api/mozilla.components.browser.storage.memory/-visit/timestamp.md create mode 100644 docs/api/mozilla.components.browser.storage.memory/-visit/type.md create mode 100644 docs/api/mozilla.components.browser.storage.memory/index.md create mode 100644 docs/api/mozilla.components.browser.storage.sync/-a-u-t-o-c-o-m-p-l-e-t-e_-s-o-u-r-c-e_-n-a-m-e.md create mode 100644 docs/api/mozilla.components.browser.storage.sync/-connection/api.md create mode 100644 docs/api/mozilla.components.browser.storage.sync/-connection/index.md create mode 100644 docs/api/mozilla.components.browser.storage.sync/-d-b_-n-a-m-e.md create mode 100644 docs/api/mozilla.components.browser.storage.sync/-places-history-storage/-init-.md create mode 100644 docs/api/mozilla.components.browser.storage.sync/-places-history-storage/cleanup.md create mode 100644 docs/api/mozilla.components.browser.storage.sync/-places-history-storage/get-autocomplete-suggestion.md create mode 100644 docs/api/mozilla.components.browser.storage.sync/-places-history-storage/get-suggestions.md create mode 100644 docs/api/mozilla.components.browser.storage.sync/-places-history-storage/get-visited.md create mode 100644 docs/api/mozilla.components.browser.storage.sync/-places-history-storage/index.md create mode 100644 docs/api/mozilla.components.browser.storage.sync/-places-history-storage/record-observation.md create mode 100644 docs/api/mozilla.components.browser.storage.sync/-places-history-storage/record-visit.md create mode 100644 docs/api/mozilla.components.browser.storage.sync/-places-history-storage/sync.md create mode 100644 docs/api/mozilla.components.browser.storage.sync/-sync-auth-info.md create mode 100644 docs/api/mozilla.components.browser.storage.sync/index.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-browser-tabs-tray/-init-.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-browser-tabs-tray/as-view.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-browser-tabs-tray/index.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-browser-tabs-tray/on-detached-from-window.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-d-e-f-a-u-l-t_-i-t-e-m_-b-a-c-k-g-r-o-u-n-d_-c-o-l-o-r.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-d-e-f-a-u-l-t_-i-t-e-m_-b-a-c-k-g-r-o-u-n-d_-s-e-l-e-c-t-e-d_-c-o-l-o-r.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-d-e-f-a-u-l-t_-i-t-e-m_-t-e-x-t_-c-o-l-o-r.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-d-e-f-a-u-l-t_-i-t-e-m_-t-e-x-t_-s-e-l-e-c-t-e-d_-c-o-l-o-r.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tab-view-holder/-init-.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tab-view-holder/bind.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tab-view-holder/index.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tab-view-holder/on-url-changed.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tab-view-holder/unbind.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tabs-adapter/-init-.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tabs-adapter/display-sessions.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tabs-adapter/get-item-count.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tabs-adapter/index.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-bind-view-holder.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-create-view-holder.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-session-moved.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-changed.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-inserted.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-removed.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-view-recycled.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tabs-adapter/unsubscribe-holders.md create mode 100644 docs/api/mozilla.components.browser.tabstray/-tabs-adapter/update-sessions.md create mode 100644 docs/api/mozilla.components.browser.tabstray/index.md create mode 100644 docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/-init-.md create mode 100644 docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/index.md create mode 100644 docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/layout-depends-on.md create mode 100644 docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/on-nested-pre-scroll.md create mode 100644 docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/on-start-nested-scroll.md create mode 100644 docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/on-stop-nested-scroll.md create mode 100644 docs/api/mozilla.components.browser.toolbar.behavior/index.md create mode 100644 docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/-init-.md create mode 100644 docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/focus.md create mode 100644 docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/index.md create mode 100644 docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/on-layout.md create mode 100644 docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/on-measure.md create mode 100644 docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/update-url.md create mode 100644 docs/api/mozilla.components.browser.toolbar.edit/index.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/-init-.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/apply-autocomplete-result.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/coroutine-context.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/index.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/no-autocomplete-result.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-async-filter-listener/-init-.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-async-filter-listener/coroutine-context.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-async-filter-listener/index.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-async-filter-listener/invoke.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-button/-init-.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-button/index.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-button/padding.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-init-.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/-init-.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/index.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/padding.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-two-state-button/-init-.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-two-state-button/bind.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-two-state-button/enabled.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-two-state-button/index.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/add-browser-action.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/add-navigation-action.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/add-page-action.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/browser-action-margin.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/display-mode.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/display-progress.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/display-site-security-icon.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/edit-mode.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/hint-color.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/hint.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/index.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/invalidate-actions.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/menu-view-color.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/on-back-pressed.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/on-layout.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/on-measure.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/on-url-clicked.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-autocomplete-listener.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-menu-builder.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-on-edit-focus-change-listener.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-on-edit-listener.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-on-url-commit-listener.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-search-terms.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-url-text-padding.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/site-secure.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/site-security-color.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/text-color.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/text-size.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/typeface.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/url-box-margin.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/url-box-view.md create mode 100644 docs/api/mozilla.components.browser.toolbar/-browser-toolbar/url.md create mode 100644 docs/api/mozilla.components.browser.toolbar/index.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-cancelled.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-changed.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-started.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/should-clear-suggestions.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-chip/-init-.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-chip/index.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-chip/title.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-flag/-b-o-o-k-m-a-r-k.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-flag/-c-l-i-p-b-o-a-r-d.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-flag/-o-p-e-n_-t-a-b.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-flag/index.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-init-.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/are-contents-the-same.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/chips.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/description.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/flags.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/icon.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/id.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/on-chip-clicked.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/on-suggestion-clicked.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/score.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/title.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/add-providers.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/as-view.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/index.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/on-input-cancelled.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/on-input-changed.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/on-input-started.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/-awesome-bar/set-on-stop-listener.md create mode 100644 docs/api/mozilla.components.concept.awesomebar/index.md create mode 100644 docs/api/mozilla.components.concept.engine.history/-history-tracking-delegate/get-visited.md create mode 100644 docs/api/mozilla.components.concept.engine.history/-history-tracking-delegate/index.md create mode 100644 docs/api/mozilla.components.concept.engine.history/-history-tracking-delegate/on-title-changed.md create mode 100644 docs/api/mozilla.components.concept.engine.history/-history-tracking-delegate/on-visited.md create mode 100644 docs/api/mozilla.components.concept.engine.history/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission-request/contains-video-and-audio-sources.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission-request/grant-if.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission-request/grant.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission-request/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission-request/permissions.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission-request/reject.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission-request/uri.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-app-audio/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-app-audio/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-app-audio/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-app-audio/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-app-camera/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-app-camera/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-app-camera/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-app-camera/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-coarse/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-coarse/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-coarse/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-coarse/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-fine/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-fine/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-fine/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-fine/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-capture/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-capture/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-capture/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-capture/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-microphone/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-microphone/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-microphone/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-microphone/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-other/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-other/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-other/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-other/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-autoplay-media/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-autoplay-media/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-autoplay-media/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-autoplay-media/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-geo-location/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-geo-location/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-geo-location/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-geo-location/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-notification/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-notification/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-notification/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-notification/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-protected-media-id/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-protected-media-id/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-protected-media-id/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-protected-media-id/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-application/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-application/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-application/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-application/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-browser/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-browser/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-browser/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-browser/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-camera/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-camera/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-camera/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-camera/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-capture/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-capture/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-capture/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-capture/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-other/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-other/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-other/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-other/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-screen/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-screen/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-screen/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-screen/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-window/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-window/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-window/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-window/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-generic/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-generic/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-generic/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/-generic/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/desc.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/id.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/-permission/index.md create mode 100644 docs/api/mozilla.components.concept.engine.permission/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-choice/-c-r-e-a-t-o-r/create-from-parcel.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-choice/-c-r-e-a-t-o-r/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-choice/-c-r-e-a-t-o-r/new-array.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-choice/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-choice/children.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-choice/create-from-parcel.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-choice/describe-contents.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-choice/enable.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-choice/id.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-choice/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-choice/is-a-separator.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-choice/is-group-type.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-choice/label.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-choice/new-array.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-choice/selected.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-choice/write-to-parcel.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/has-shown-many-dialogs.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/message.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/on-confirm.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/on-dismiss.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/title.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-level/-n-o-n-e.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-level/-p-a-s-s-w-o-r-d_-e-n-c-r-y-p-t-e-d.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-level/-s-e-c-u-r-e-d.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-level/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-method/-h-o-s-t.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-method/-p-r-o-x-y.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-method/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/is-cross-origin.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/level.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/message.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/method.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/on-confirm.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/on-dismiss.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/only-show-password.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/password.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/previous-failed.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/title.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/user-name.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/default-color.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/on-confirm.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/on-dismiss.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/has-shown-many-dialogs.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/message.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/negative-button-title.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/neutral-button-title.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/on-confirm-negative-button.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/on-confirm-neutral-button.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/on-confirm-positive-button.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/on-dismiss.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/positive-button-title.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/title.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/is-multiple-files-selection.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/mime-types.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/on-dismiss.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/on-multiple-files-selected.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/on-single-file-selected.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-menu-choice/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-menu-choice/choices.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-menu-choice/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-menu-choice/on-confirm.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-multiple-choice/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-multiple-choice/choices.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-multiple-choice/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-multiple-choice/on-confirm.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/on-allow.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/on-deny.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/target-uri.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-single-choice/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-single-choice/choices.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-single-choice/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-single-choice/on-confirm.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/has-shown-many-dialogs.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/input-label.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/input-value.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/on-confirm.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/on-dismiss.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/title.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-type/-d-a-t-e.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-type/-d-a-t-e_-a-n-d_-t-i-m-e.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-type/-t-i-m-e.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-type/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/initial-date.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/maximum-date.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/minimum-date.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/on-clear.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/on-confirm.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/title.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/type.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/-prompt-request/index.md create mode 100644 docs/api/mozilla.components.concept.engine.prompt/index.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/data.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/encoding.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/index.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/mime-type.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/url.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/data.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/encoding.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/index.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/mime-type.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-url/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-url/index.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-url/url.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/index.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/index.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/on-error-request.md create mode 100644 docs/api/mozilla.components.concept.engine.request/-request-interceptor/on-load-request.md create mode 100644 docs/api/mozilla.components.concept.engine.request/index.md create mode 100644 docs/api/mozilla.components.concept.engine.window/-window-request/index.md create mode 100644 docs/api/mozilla.components.concept.engine.window/-window-request/prepare.md create mode 100644 docs/api/mozilla.components.concept.engine.window/-window-request/start.md create mode 100644 docs/api/mozilla.components.concept.engine.window/-window-request/url.md create mode 100644 docs/api/mozilla.components.concept.engine.window/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/allow-content-access.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/allow-file-access-from-file-u-r-ls.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/allow-file-access.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/allow-universal-access-from-file-u-r-ls.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/display-zoom-controls.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/dom-storage-enabled.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/history-tracking-delegate.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/horizontal-scroll-bar-enabled.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/java-script-can-open-windows-automatically.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/javascript-enabled.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/load-with-overview-mode.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/media-playback-requires-user-gesture.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/remote-debugging-enabled.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/request-interceptor.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/support-multiple-windows.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/testing-mode-enabled.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/tracking-protection-policy.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/user-agent-string.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/vertical-scroll-bar-enabled.md create mode 100644 docs/api/mozilla.components.concept.engine/-default-settings/web-fonts-enabled.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session-state/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session-state/to-j-s-o-n.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-app-permission-request.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-cancel-content-permission-request.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-close-window-request.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-content-permission-request.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-desktop-mode-change.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-external-resource.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-find-result.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-find.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-full-screen-change.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-loading-state-change.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-location-change.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-long-press.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-navigation-state-change.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-open-window-request.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-progress.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-prompt-request.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-security-change.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-thumbnail-change.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-title-change.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-tracker-blocked.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-tracker-blocking-enabled-change.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy-for-session-types/for-private-sessions-only.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy-for-session-types/for-regular-sessions-only.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy-for-session-types/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-a-d.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-a-n-a-l-y-t-i-c-s.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-c-o-n-t-e-n-t.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-s-o-c-i-a-l.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-t-e-s-t.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/all.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/categories.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/contains.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/equals.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/hash-code.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/none.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/select.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/use-for-private-sessions.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/use-for-regular-sessions.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/capture-thumbnail.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/clear-data.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/clear-find-matches.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/close.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/disable-tracking-protection.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/enable-tracking-protection.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/exit-full-screen-mode.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/find-all.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/find-next.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/go-back.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/go-forward.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/load-data.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/load-url.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/reload.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/restore-state.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/save-state.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/settings.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/stop-loading.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-session/toggle-desktop-mode.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-view/as-view.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-view/can-scroll-vertically-down.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-view/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-view/on-create.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-view/on-destroy.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-view/on-pause.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-view/on-resume.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-view/on-start.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-view/on-stop.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine-view/render.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine/create-session-state.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine/create-session.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine/create-view.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine/name.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine/settings.md create mode 100644 docs/api/mozilla.components.concept.engine/-engine/speculative-connect.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/src.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/src.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-g-e-o/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-g-e-o/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-g-e-o/src.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/src.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/src.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/uri.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/src.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/src.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/src.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-hit-result/src.md create mode 100644 docs/api/mozilla.components.concept.engine/-lifecycle-observer/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine/-lifecycle-observer/engine-view.md create mode 100644 docs/api/mozilla.components.concept.engine/-lifecycle-observer/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-create.md create mode 100644 docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-destroy.md create mode 100644 docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-pause.md create mode 100644 docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-resume.md create mode 100644 docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-start.md create mode 100644 docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-stop.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/allow-content-access.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/allow-file-access-from-file-u-r-ls.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/allow-file-access.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/allow-universal-access-from-file-u-r-ls.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/display-zoom-controls.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/dom-storage-enabled.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/history-tracking-delegate.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/horizontal-scroll-bar-enabled.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/java-script-can-open-windows-automatically.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/javascript-enabled.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/load-with-overview-mode.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/media-playback-requires-user-gesture.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/remote-debugging-enabled.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/request-interceptor.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/support-multiple-windows.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/testing-mode-enabled.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/tracking-protection-policy.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/user-agent-string.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/vertical-scroll-bar-enabled.md create mode 100644 docs/api/mozilla.components.concept.engine/-settings/web-fonts-enabled.md create mode 100644 docs/api/mozilla.components.concept.engine/-unsupported-setting-exception/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine/-unsupported-setting-exception/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-unsupported-setting/-init-.md create mode 100644 docs/api/mozilla.components.concept.engine/-unsupported-setting/get-value.md create mode 100644 docs/api/mozilla.components.concept.engine/-unsupported-setting/index.md create mode 100644 docs/api/mozilla.components.concept.engine/-unsupported-setting/set-value.md create mode 100644 docs/api/mozilla.components.concept.engine/index.md create mode 100644 docs/api/mozilla.components.concept.fetch/-client/-init-.md create mode 100644 docs/api/mozilla.components.concept.fetch/-client/default-headers.md create mode 100644 docs/api/mozilla.components.concept.fetch/-client/fetch.md create mode 100644 docs/api/mozilla.components.concept.fetch/-client/index.md create mode 100644 docs/api/mozilla.components.concept.fetch/-header/-init-.md create mode 100644 docs/api/mozilla.components.concept.fetch/-header/index.md create mode 100644 docs/api/mozilla.components.concept.fetch/-header/name.md create mode 100644 docs/api/mozilla.components.concept.fetch/-header/value.md create mode 100644 docs/api/mozilla.components.concept.fetch/-headers/contains.md create mode 100644 docs/api/mozilla.components.concept.fetch/-headers/get-all.md create mode 100644 docs/api/mozilla.components.concept.fetch/-headers/get.md create mode 100644 docs/api/mozilla.components.concept.fetch/-headers/index.md create mode 100644 docs/api/mozilla.components.concept.fetch/-headers/set.md create mode 100644 docs/api/mozilla.components.concept.fetch/-headers/size.md create mode 100644 docs/api/mozilla.components.concept.fetch/-mutable-headers/-init-.md create mode 100644 docs/api/mozilla.components.concept.fetch/-mutable-headers/append.md create mode 100644 docs/api/mozilla.components.concept.fetch/-mutable-headers/contains.md create mode 100644 docs/api/mozilla.components.concept.fetch/-mutable-headers/get-all.md create mode 100644 docs/api/mozilla.components.concept.fetch/-mutable-headers/get.md create mode 100644 docs/api/mozilla.components.concept.fetch/-mutable-headers/index.md create mode 100644 docs/api/mozilla.components.concept.fetch/-mutable-headers/iterator.md create mode 100644 docs/api/mozilla.components.concept.fetch/-mutable-headers/set.md create mode 100644 docs/api/mozilla.components.concept.fetch/-mutable-headers/size.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-body/-init-.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-body/close.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-body/from-file.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-body/from-string.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-body/index.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-body/use-stream.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-init-.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-method/-c-o-n-n-e-c-t.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-method/-d-e-l-e-t-e.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-method/-g-e-t.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-method/-h-e-a-d.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-method/-o-p-t-i-o-n-s.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-method/-p-o-s-t.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-method/-p-u-t.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-method/-t-r-a-c-e.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-method/index.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-redirect/-f-o-l-l-o-w.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-redirect/-m-a-n-u-a-l.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/-redirect/index.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/body.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/connect-timeout.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/headers.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/index.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/method.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/read-timeout.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/redirect.md create mode 100644 docs/api/mozilla.components.concept.fetch/-request/url.md create mode 100644 docs/api/mozilla.components.concept.fetch/-response/-body/-init-.md create mode 100644 docs/api/mozilla.components.concept.fetch/-response/-body/close.md create mode 100644 docs/api/mozilla.components.concept.fetch/-response/-body/empty.md create mode 100644 docs/api/mozilla.components.concept.fetch/-response/-body/index.md create mode 100644 docs/api/mozilla.components.concept.fetch/-response/-body/string.md create mode 100644 docs/api/mozilla.components.concept.fetch/-response/-body/use-buffered-reader.md create mode 100644 docs/api/mozilla.components.concept.fetch/-response/-body/use-stream.md create mode 100644 docs/api/mozilla.components.concept.fetch/-response/-init-.md create mode 100644 docs/api/mozilla.components.concept.fetch/-response/body.md create mode 100644 docs/api/mozilla.components.concept.fetch/-response/close.md create mode 100644 docs/api/mozilla.components.concept.fetch/-response/headers.md create mode 100644 docs/api/mozilla.components.concept.fetch/-response/index.md create mode 100644 docs/api/mozilla.components.concept.fetch/-response/status.md create mode 100644 docs/api/mozilla.components.concept.fetch/-response/url.md create mode 100644 docs/api/mozilla.components.concept.fetch/client-error.md create mode 100644 docs/api/mozilla.components.concept.fetch/index.md create mode 100644 docs/api/mozilla.components.concept.fetch/success.md create mode 100644 docs/api/mozilla.components.concept.storage/-history-autocomplete-result/-init-.md create mode 100644 docs/api/mozilla.components.concept.storage/-history-autocomplete-result/index.md create mode 100644 docs/api/mozilla.components.concept.storage/-history-autocomplete-result/input.md create mode 100644 docs/api/mozilla.components.concept.storage/-history-autocomplete-result/source.md create mode 100644 docs/api/mozilla.components.concept.storage/-history-autocomplete-result/text.md create mode 100644 docs/api/mozilla.components.concept.storage/-history-autocomplete-result/total-items.md create mode 100644 docs/api/mozilla.components.concept.storage/-history-autocomplete-result/url.md create mode 100644 docs/api/mozilla.components.concept.storage/-history-storage/cleanup.md create mode 100644 docs/api/mozilla.components.concept.storage/-history-storage/get-autocomplete-suggestion.md create mode 100644 docs/api/mozilla.components.concept.storage/-history-storage/get-suggestions.md create mode 100644 docs/api/mozilla.components.concept.storage/-history-storage/get-visited.md create mode 100644 docs/api/mozilla.components.concept.storage/-history-storage/index.md create mode 100644 docs/api/mozilla.components.concept.storage/-history-storage/record-observation.md create mode 100644 docs/api/mozilla.components.concept.storage/-history-storage/record-visit.md create mode 100644 docs/api/mozilla.components.concept.storage/-page-observation/-init-.md create mode 100644 docs/api/mozilla.components.concept.storage/-page-observation/index.md create mode 100644 docs/api/mozilla.components.concept.storage/-page-observation/title.md create mode 100644 docs/api/mozilla.components.concept.storage/-search-result/-init-.md create mode 100644 docs/api/mozilla.components.concept.storage/-search-result/id.md create mode 100644 docs/api/mozilla.components.concept.storage/-search-result/index.md create mode 100644 docs/api/mozilla.components.concept.storage/-search-result/score.md create mode 100644 docs/api/mozilla.components.concept.storage/-search-result/title.md create mode 100644 docs/api/mozilla.components.concept.storage/-search-result/url.md create mode 100644 docs/api/mozilla.components.concept.storage/-sync-error/-init-.md create mode 100644 docs/api/mozilla.components.concept.storage/-sync-error/exception.md create mode 100644 docs/api/mozilla.components.concept.storage/-sync-error/index.md create mode 100644 docs/api/mozilla.components.concept.storage/-sync-ok.md create mode 100644 docs/api/mozilla.components.concept.storage/-sync-status.md create mode 100644 docs/api/mozilla.components.concept.storage/-syncable-store/index.md create mode 100644 docs/api/mozilla.components.concept.storage/-syncable-store/sync.md create mode 100644 docs/api/mozilla.components.concept.storage/-visit-type/-l-i-n-k.md create mode 100644 docs/api/mozilla.components.concept.storage/-visit-type/-r-e-l-o-a-d.md create mode 100644 docs/api/mozilla.components.concept.storage/-visit-type/-t-y-p-e-d.md create mode 100644 docs/api/mozilla.components.concept.storage/-visit-type/index.md create mode 100644 docs/api/mozilla.components.concept.storage/-visit-type/type.md create mode 100644 docs/api/mozilla.components.concept.storage/index.md create mode 100644 docs/api/mozilla.components.concept.tabstray/-tabs-tray/-observer/index.md create mode 100644 docs/api/mozilla.components.concept.tabstray/-tabs-tray/-observer/on-tab-closed.md create mode 100644 docs/api/mozilla.components.concept.tabstray/-tabs-tray/-observer/on-tab-selected.md create mode 100644 docs/api/mozilla.components.concept.tabstray/-tabs-tray/as-view.md create mode 100644 docs/api/mozilla.components.concept.tabstray/-tabs-tray/display-sessions.md create mode 100644 docs/api/mozilla.components.concept.tabstray/-tabs-tray/index.md create mode 100644 docs/api/mozilla.components.concept.tabstray/-tabs-tray/on-session-moved.md create mode 100644 docs/api/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-changed.md create mode 100644 docs/api/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-inserted.md create mode 100644 docs/api/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-removed.md create mode 100644 docs/api/mozilla.components.concept.tabstray/-tabs-tray/update-sessions.md create mode 100644 docs/api/mozilla.components.concept.tabstray/index.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-autocomplete-delegate/apply-autocomplete-result.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-autocomplete-delegate/index.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-autocomplete-delegate/no-autocomplete-result.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-autocomplete-result/-init-.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-autocomplete-result/index.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-autocomplete-result/input.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-autocomplete-result/source.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-autocomplete-result/text.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-autocomplete-result/total-items.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-autocomplete-result/url.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/-init-.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/bind.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/content-description.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/create-view.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/image-drawable.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/index.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/visible.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-image/-init-.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-image/bind.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-image/create-view.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-image/index.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-space/-init-.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-space/bind.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-space/create-view.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-space/index.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/-init-.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/bind.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/create-view.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/index.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/is-selected.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/set-selected.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/toggle.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/visible.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action/bind.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action/create-view.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action/index.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-action/visible.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/index.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/on-start-editing.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/on-stop-editing.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/on-text-changed.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-site-security/-i-n-s-e-c-u-r-e.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-site-security/-s-e-c-u-r-e.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/-site-security/index.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/add-browser-action.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/add-navigation-action.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/add-page-action.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/as-view.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/display-mode.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/display-progress.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/edit-mode.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/index.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/on-back-pressed.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/set-autocomplete-listener.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/set-on-edit-listener.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/set-on-url-commit-listener.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/set-search-terms.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/site-secure.md create mode 100644 docs/api/mozilla.components.concept.toolbar/-toolbar/url.md create mode 100644 docs/api/mozilla.components.concept.toolbar/index.md create mode 100644 docs/api/mozilla.components.feature.accounts/-firefox-accounts-auth-feature/-init-.md create mode 100644 docs/api/mozilla.components.feature.accounts/-firefox-accounts-auth-feature/begin-authentication.md create mode 100644 docs/api/mozilla.components.feature.accounts/-firefox-accounts-auth-feature/index.md create mode 100644 docs/api/mozilla.components.feature.accounts/-firefox-accounts-auth-feature/interceptor.md create mode 100644 docs/api/mozilla.components.feature.accounts/index.md create mode 100644 docs/api/mozilla.components.feature.awesomebar.provider/-clipboard-suggestion-provider/-init-.md create mode 100644 docs/api/mozilla.components.feature.awesomebar.provider/-clipboard-suggestion-provider/index.md create mode 100644 docs/api/mozilla.components.feature.awesomebar.provider/-clipboard-suggestion-provider/on-input-changed.md create mode 100644 docs/api/mozilla.components.feature.awesomebar.provider/-history-storage-suggestion-provider/-init-.md create mode 100644 docs/api/mozilla.components.feature.awesomebar.provider/-history-storage-suggestion-provider/index.md create mode 100644 docs/api/mozilla.components.feature.awesomebar.provider/-history-storage-suggestion-provider/on-input-changed.md create mode 100644 docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-init-.md create mode 100644 docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-mode/-m-u-l-t-i-p-l-e_-s-u-g-g-e-s-t-i-o-n-s.md create mode 100644 docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-mode/-s-i-n-g-l-e_-s-u-g-g-e-s-t-i-o-n.md create mode 100644 docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-mode/index.md create mode 100644 docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/index.md create mode 100644 docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/on-input-changed.md create mode 100644 docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/should-clear-suggestions.md create mode 100644 docs/api/mozilla.components.feature.awesomebar.provider/-session-suggestion-provider/-init-.md create mode 100644 docs/api/mozilla.components.feature.awesomebar.provider/-session-suggestion-provider/index.md create mode 100644 docs/api/mozilla.components.feature.awesomebar.provider/-session-suggestion-provider/on-input-changed.md create mode 100644 docs/api/mozilla.components.feature.awesomebar.provider/index.md create mode 100644 docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/-init-.md create mode 100644 docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/add-clipboard-provider.md create mode 100644 docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/add-history-provider.md create mode 100644 docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/add-search-provider.md create mode 100644 docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/add-session-provider.md create mode 100644 docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/index.md create mode 100644 docs/api/mozilla.components.feature.awesomebar/index.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/-init-.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/action.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-copy-image-location-candidate.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-copy-link-candidate.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-open-image-in-new-tab-candidate.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-open-in-new-tab-candidate.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-open-in-private-tab-candidate.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-save-image-candidate.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-share-link-candidate.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/default-candidates.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/id.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/index.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/label.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/show-for.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-feature/-init-.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-feature/index.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-feature/start.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-feature/stop.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-fragment/-init-.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-fragment/create.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-fragment/index.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/-context-menu-fragment/on-create-dialog.md create mode 100644 docs/api/mozilla.components.feature.contextmenu/index.md create mode 100644 docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/-init-.md create mode 100644 docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/engine.md create mode 100644 docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/extra-command.md create mode 100644 docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/index.md create mode 100644 docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/may-launch-url.md create mode 100644 docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/new-session.md create mode 100644 docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/post-message.md create mode 100644 docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/request-post-message-channel.md create mode 100644 docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/update-visuals.md create mode 100644 docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/validate-relationship.md create mode 100644 docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/warmup.md create mode 100644 docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/-init-.md create mode 100644 docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/index.md create mode 100644 docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/on-back-pressed.md create mode 100644 docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/start.md create mode 100644 docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/stop.md create mode 100644 docs/api/mozilla.components.feature.customtabs/index.md create mode 100644 docs/api/mozilla.components.feature.downloads/-android-download-manager.md create mode 100644 docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-f-r-a-g-m-e-n-t_-t-a-g.md create mode 100644 docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-init-.md create mode 100644 docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-k-e-y_-c-o-n-t-e-n-t_-l-e-n-g-t-h.md create mode 100644 docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-k-e-y_-f-i-l-e_-n-a-m-e.md create mode 100644 docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-k-e-y_-u-r-l.md create mode 100644 docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/index.md create mode 100644 docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/on-start-download.md create mode 100644 docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/set-download.md create mode 100644 docs/api/mozilla.components.feature.downloads/-download-manager/-init-.md create mode 100644 docs/api/mozilla.components.feature.downloads/-download-manager/download.md create mode 100644 docs/api/mozilla.components.feature.downloads/-download-manager/index.md create mode 100644 docs/api/mozilla.components.feature.downloads/-download-manager/on-download-completed.md create mode 100644 docs/api/mozilla.components.feature.downloads/-download-manager/unregister-listener.md create mode 100644 docs/api/mozilla.components.feature.downloads/-downloads-feature/-init-.md create mode 100644 docs/api/mozilla.components.feature.downloads/-downloads-feature/index.md create mode 100644 docs/api/mozilla.components.feature.downloads/-downloads-feature/on-download-completed.md create mode 100644 docs/api/mozilla.components.feature.downloads/-downloads-feature/on-download.md create mode 100644 docs/api/mozilla.components.feature.downloads/-downloads-feature/on-need-to-request-permissions.md create mode 100644 docs/api/mozilla.components.feature.downloads/-downloads-feature/on-permissions-result.md create mode 100644 docs/api/mozilla.components.feature.downloads/-downloads-feature/start.md create mode 100644 docs/api/mozilla.components.feature.downloads/-downloads-feature/stop.md create mode 100644 docs/api/mozilla.components.feature.downloads/-on-download-completed.md create mode 100644 docs/api/mozilla.components.feature.downloads/-on-need-to-request-permissions.md create mode 100644 docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-init-.md create mode 100644 docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-c-a-n-c-e-l-a-b-l-e.md create mode 100644 docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-n-e-g-a-t-i-v-e_-t-e-x-t.md create mode 100644 docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-p-o-s-i-t-i-v-e_-t-e-x-t.md create mode 100644 docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-t-h-e-m-e_-i-d.md create mode 100644 docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-t-i-t-l-e_-t-e-x-t.md create mode 100644 docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/index.md create mode 100644 docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/new-instance.md create mode 100644 docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/on-create-dialog.md create mode 100644 docs/api/mozilla.components.feature.downloads/index.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/-init-.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/clear.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/display-result.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/focus.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/index.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/listener.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/index.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-clear-matches.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-close.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-find-all.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-next-result.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-previous-result.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/as-view.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/clear.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/display-result.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/focus.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/index.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/listener.md create mode 100644 docs/api/mozilla.components.feature.findinpage.view/index.md create mode 100644 docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/-init-.md create mode 100644 docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/bind.md create mode 100644 docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/index.md create mode 100644 docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/on-back-pressed.md create mode 100644 docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/start.md create mode 100644 docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/stop.md create mode 100644 docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/unbind.md create mode 100644 docs/api/mozilla.components.feature.findinpage/index.md create mode 100644 docs/api/mozilla.components.feature.intent/-intent-handler.md create mode 100644 docs/api/mozilla.components.feature.intent/-intent-processor/-a-c-t-i-v-e_-s-e-s-s-i-o-n_-i-d.md create mode 100644 docs/api/mozilla.components.feature.intent/-intent-processor/-init-.md create mode 100644 docs/api/mozilla.components.feature.intent/-intent-processor/index.md create mode 100644 docs/api/mozilla.components.feature.intent/-intent-processor/process.md create mode 100644 docs/api/mozilla.components.feature.intent/-intent-processor/register-handler.md create mode 100644 docs/api/mozilla.components.feature.intent/-intent-processor/unregister-handler.md create mode 100644 docs/api/mozilla.components.feature.intent/index.md create mode 100644 docs/api/mozilla.components.feature.prompts/-on-need-to-request-permissions.md create mode 100644 docs/api/mozilla.components.feature.prompts/-prompt-feature/-f-i-l-e_-p-i-c-k-e-r_-a-c-t-i-v-i-t-y_-r-e-q-u-e-s-t_-c-o-d-e.md create mode 100644 docs/api/mozilla.components.feature.prompts/-prompt-feature/-init-.md create mode 100644 docs/api/mozilla.components.feature.prompts/-prompt-feature/index.md create mode 100644 docs/api/mozilla.components.feature.prompts/-prompt-feature/on-activity-result.md create mode 100644 docs/api/mozilla.components.feature.prompts/-prompt-feature/on-permissions-result.md create mode 100644 docs/api/mozilla.components.feature.prompts/-prompt-feature/start.md create mode 100644 docs/api/mozilla.components.feature.prompts/-prompt-feature/stop.md create mode 100644 docs/api/mozilla.components.feature.prompts/index.md create mode 100644 docs/api/mozilla.components.feature.search/-search-use-cases/-default-search-use-case/-init-.md create mode 100644 docs/api/mozilla.components.feature.search/-search-use-cases/-default-search-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.search/-search-use-cases/-default-search-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.search/-search-use-cases/-init-.md create mode 100644 docs/api/mozilla.components.feature.search/-search-use-cases/-new-tab-search-use-case/-init-.md create mode 100644 docs/api/mozilla.components.feature.search/-search-use-cases/-new-tab-search-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.search/-search-use-cases/-new-tab-search-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.search/-search-use-cases/-search-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.search/-search-use-cases/-search-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.search/-search-use-cases/default-search.md create mode 100644 docs/api/mozilla.components.feature.search/-search-use-cases/index.md create mode 100644 docs/api/mozilla.components.feature.search/-search-use-cases/new-tab-search.md create mode 100644 docs/api/mozilla.components.feature.search/index.md create mode 100644 docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/-init-.md create mode 100644 docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/auto-save.md create mode 100644 docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/bundles-paged.md create mode 100644 docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/bundles.md create mode 100644 docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/current.md create mode 100644 docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/index.md create mode 100644 docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/remove-all.md create mode 100644 docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/remove.md create mode 100644 docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/restore.md create mode 100644 docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/save.md create mode 100644 docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/use.md create mode 100644 docs/api/mozilla.components.feature.session.bundling/-session-bundle/id.md create mode 100644 docs/api/mozilla.components.feature.session.bundling/-session-bundle/index.md create mode 100644 docs/api/mozilla.components.feature.session.bundling/-session-bundle/last-saved-at.md create mode 100644 docs/api/mozilla.components.feature.session.bundling/-session-bundle/restore-snapshot.md create mode 100644 docs/api/mozilla.components.feature.session.bundling/-session-bundle/urls.md create mode 100644 docs/api/mozilla.components.feature.session.bundling/index.md create mode 100644 docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/-d-e-f-a-u-l-t_-s-c-r-o-l-l_-f-l-a-g-s.md create mode 100644 docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/-init-.md create mode 100644 docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/index.md create mode 100644 docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/on-loading-state-changed.md create mode 100644 docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/start.md create mode 100644 docs/api/mozilla.components.feature.session/-engine-view-presenter/-init-.md create mode 100644 docs/api/mozilla.components.feature.session/-engine-view-presenter/index.md create mode 100644 docs/api/mozilla.components.feature.session/-engine-view-presenter/on-session-selected.md create mode 100644 docs/api/mozilla.components.feature.session/-engine-view-presenter/start.md create mode 100644 docs/api/mozilla.components.feature.session/-engine-view-presenter/stop.md create mode 100644 docs/api/mozilla.components.feature.session/-full-screen-feature/-init-.md create mode 100644 docs/api/mozilla.components.feature.session/-full-screen-feature/index.md create mode 100644 docs/api/mozilla.components.feature.session/-full-screen-feature/on-back-pressed.md create mode 100644 docs/api/mozilla.components.feature.session/-full-screen-feature/on-full-screen-changed.md create mode 100644 docs/api/mozilla.components.feature.session/-full-screen-feature/start.md create mode 100644 docs/api/mozilla.components.feature.session/-history-delegate/-init-.md create mode 100644 docs/api/mozilla.components.feature.session/-history-delegate/get-visited.md create mode 100644 docs/api/mozilla.components.feature.session/-history-delegate/index.md create mode 100644 docs/api/mozilla.components.feature.session/-history-delegate/on-title-changed.md create mode 100644 docs/api/mozilla.components.feature.session/-history-delegate/on-visited.md create mode 100644 docs/api/mozilla.components.feature.session/-session-feature/-init-.md create mode 100644 docs/api/mozilla.components.feature.session/-session-feature/index.md create mode 100644 docs/api/mozilla.components.feature.session/-session-feature/on-back-pressed.md create mode 100644 docs/api/mozilla.components.feature.session/-session-feature/start.md create mode 100644 docs/api/mozilla.components.feature.session/-session-feature/stop.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-clear-data-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-clear-data-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-default-load-url-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-default-load-url-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-exit-full-screen-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-exit-full-screen-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-go-back-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-go-back-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-go-forward-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-go-forward-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-init-.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-load-data-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-load-data-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-load-url-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-reload-url-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-reload-url-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-request-desktop-site-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-request-desktop-site-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-stop-loading-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/-stop-loading-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/clear-data.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/exit-fullscreen.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/go-back.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/go-forward.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/index.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/load-data.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/load-url.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/reload.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/request-desktop-site.md create mode 100644 docs/api/mozilla.components.feature.session/-session-use-cases/stop-loading.md create mode 100644 docs/api/mozilla.components.feature.session/-window-feature/-init-.md create mode 100644 docs/api/mozilla.components.feature.session/-window-feature/index.md create mode 100644 docs/api/mozilla.components.feature.session/-window-feature/start.md create mode 100644 docs/api/mozilla.components.feature.session/-window-feature/stop.md create mode 100644 docs/api/mozilla.components.feature.session/index.md create mode 100644 docs/api/mozilla.components.feature.sitepermissions/-on-need-to-request-permissions.md create mode 100644 docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/-init-.md create mode 100644 docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/index.md create mode 100644 docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/on-content-permission-deny.md create mode 100644 docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/on-content-permission-granted.md create mode 100644 docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/on-permissions-result.md create mode 100644 docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/start.md create mode 100644 docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/stop.md create mode 100644 docs/api/mozilla.components.feature.sitepermissions/index.md create mode 100644 docs/api/mozilla.components.feature.sync/-auth-exception-type/-k-e-y_-i-n-f-o.md create mode 100644 docs/api/mozilla.components.feature.sync/-auth-exception-type/index.md create mode 100644 docs/api/mozilla.components.feature.sync/-auth-exception-type/msg.md create mode 100644 docs/api/mozilla.components.feature.sync/-auth-exception/-init-.md create mode 100644 docs/api/mozilla.components.feature.sync/-auth-exception/index.md create mode 100644 docs/api/mozilla.components.feature.sync/-firefox-sync-feature/-init-.md create mode 100644 docs/api/mozilla.components.feature.sync/-firefox-sync-feature/index.md create mode 100644 docs/api/mozilla.components.feature.sync/-firefox-sync-feature/sync-running.md create mode 100644 docs/api/mozilla.components.feature.sync/-firefox-sync-feature/sync.md create mode 100644 docs/api/mozilla.components.feature.sync/-fxa-auth-info/-init-.md create mode 100644 docs/api/mozilla.components.feature.sync/-fxa-auth-info/fxa-access-token.md create mode 100644 docs/api/mozilla.components.feature.sync/-fxa-auth-info/index.md create mode 100644 docs/api/mozilla.components.feature.sync/-fxa-auth-info/kid.md create mode 100644 docs/api/mozilla.components.feature.sync/-fxa-auth-info/sync-key.md create mode 100644 docs/api/mozilla.components.feature.sync/-fxa-auth-info/token-server-url.md create mode 100644 docs/api/mozilla.components.feature.sync/-store-sync-status/-init-.md create mode 100644 docs/api/mozilla.components.feature.sync/-store-sync-status/index.md create mode 100644 docs/api/mozilla.components.feature.sync/-store-sync-status/status.md create mode 100644 docs/api/mozilla.components.feature.sync/-sync-result.md create mode 100644 docs/api/mozilla.components.feature.sync/-sync-status-observer/index.md create mode 100644 docs/api/mozilla.components.feature.sync/-sync-status-observer/on-error.md create mode 100644 docs/api/mozilla.components.feature.sync/-sync-status-observer/on-idle.md create mode 100644 docs/api/mozilla.components.feature.sync/-sync-status-observer/on-started.md create mode 100644 docs/api/mozilla.components.feature.sync/index.md create mode 100644 docs/api/mozilla.components.feature.sync/registry.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/-init-.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/filter-tabs.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/index.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/start.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/stop.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/-init-.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/index.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/on-tab-closed.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/on-tab-selected.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/start.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/stop.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/-init-.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/index.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-all-sessions-removed.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-added.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-removed.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-selected.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/start.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/stop.md create mode 100644 docs/api/mozilla.components.feature.tabs.tabstray/index.md create mode 100644 docs/api/mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/-init-.md create mode 100644 docs/api/mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/bind.md create mode 100644 docs/api/mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/create-view.md create mode 100644 docs/api/mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/index.md create mode 100644 docs/api/mozilla.components.feature.tabs.toolbar/-tabs-toolbar-feature/-init-.md create mode 100644 docs/api/mozilla.components.feature.tabs.toolbar/-tabs-toolbar-feature/index.md create mode 100644 docs/api/mozilla.components.feature.tabs.toolbar/index.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-private-tab-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-private-tab-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-tab-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-tab-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-init-.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-all-tabs-of-type-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-all-tabs-of-type-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-all-tabs-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-all-tabs-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/index.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/invoke.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/add-private-tab.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/add-tab.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/index.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/remove-all-tabs-of-type.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/remove-all-tabs.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/remove-tab.md create mode 100644 docs/api/mozilla.components.feature.tabs/-tabs-use-cases/select-tab.md create mode 100644 docs/api/mozilla.components.feature.tabs/index.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-search-use-case.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/-init-.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/add-domain-provider.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/add-history-storage-provider.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/index.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/toolbar.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-feature/-init-.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-feature/index.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-feature/on-back-pressed.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-feature/start.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-feature/stop.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-feature/toolbar.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-interactor/-init-.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-interactor/index.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-interactor/start.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-interactor/stop.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/-init-.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/index.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-progress.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-search.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-security-changed.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-session-selected.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-url-changed.md create mode 100644 docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/start.md create mode 100644 docs/api/mozilla.components.feature.toolbar/index.md create mode 100644 docs/api/mozilla.components.lib.crash.handler/-crash-handler-service/-init-.md create mode 100644 docs/api/mozilla.components.lib.crash.handler/-crash-handler-service/index.md create mode 100644 docs/api/mozilla.components.lib.crash.handler/-crash-handler-service/on-handle-intent.md create mode 100644 docs/api/mozilla.components.lib.crash.handler/-exception-handler/-init-.md create mode 100644 docs/api/mozilla.components.lib.crash.handler/-exception-handler/index.md create mode 100644 docs/api/mozilla.components.lib.crash.handler/-exception-handler/uncaught-exception.md create mode 100644 docs/api/mozilla.components.lib.crash.handler/index.md create mode 100644 docs/api/mozilla.components.lib.crash.prompt/-crash-reporter-activity/-init-.md create mode 100644 docs/api/mozilla.components.lib.crash.prompt/-crash-reporter-activity/index.md create mode 100644 docs/api/mozilla.components.lib.crash.prompt/-crash-reporter-activity/on-back-pressed.md create mode 100644 docs/api/mozilla.components.lib.crash.prompt/-crash-reporter-activity/on-create.md create mode 100644 docs/api/mozilla.components.lib.crash.prompt/index.md create mode 100644 docs/api/mozilla.components.lib.crash.service/-crash-reporter-service/index.md create mode 100644 docs/api/mozilla.components.lib.crash.service/-crash-reporter-service/report.md create mode 100644 docs/api/mozilla.components.lib.crash.service/-gecko-crash-reporter.md create mode 100644 docs/api/mozilla.components.lib.crash.service/-mozilla-socorro-service/-init-.md create mode 100644 docs/api/mozilla.components.lib.crash.service/-mozilla-socorro-service/index.md create mode 100644 docs/api/mozilla.components.lib.crash.service/-mozilla-socorro-service/report.md create mode 100644 docs/api/mozilla.components.lib.crash.service/-sentry-service/-init-.md create mode 100644 docs/api/mozilla.components.lib.crash.service/-sentry-service/index.md create mode 100644 docs/api/mozilla.components.lib.crash.service/-sentry-service/report.md create mode 100644 docs/api/mozilla.components.lib.crash.service/index.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash-reporter/-init-.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt-configuration/-init-.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt-configuration/index.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt/-a-l-w-a-y-s.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt/-n-e-v-e-r.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt/-o-n-l-y_-n-a-t-i-v-e_-c-r-a-s-h.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt/index.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash-reporter/enabled.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash-reporter/index.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash-reporter/install.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash-reporter/submit-report.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/-init-.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/extras-path.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/index.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/is-fatal.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/minidump-path.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/minidump-success.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash/-uncaught-exception-crash/-init-.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash/-uncaught-exception-crash/index.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash/-uncaught-exception-crash/throwable.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash/from-intent.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash/index.md create mode 100644 docs/api/mozilla.components.lib.crash/-crash/is-crash-intent.md create mode 100644 docs/api/mozilla.components.lib.crash/index.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/-init-.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/get-key-for.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/get-key-store.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/index.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/load-key-store.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/make-key-for.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/remove-key-for.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-keystore-exception/-init-.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-keystore-exception/index.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-keystore/-init-.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-keystore/available.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-keystore/create-decrypt-cipher.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-keystore/create-encrypt-cipher.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-keystore/decrypt-bytes.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-keystore/delete-key.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-keystore/encrypt-bytes.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-keystore/generate-key.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-keystore/index.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/-keystore/label.md create mode 100644 docs/api/mozilla.components.lib.dataprotect/index.md create mode 100644 docs/api/mozilla.components.lib.fetch.httpurlconnection/-http-u-r-l-connection-client/-init-.md create mode 100644 docs/api/mozilla.components.lib.fetch.httpurlconnection/-http-u-r-l-connection-client/fetch.md create mode 100644 docs/api/mozilla.components.lib.fetch.httpurlconnection/-http-u-r-l-connection-client/index.md create mode 100644 docs/api/mozilla.components.lib.fetch.httpurlconnection/index.md create mode 100644 docs/api/mozilla.components.lib.fetch.okhttp/-ok-http-client/-init-.md create mode 100644 docs/api/mozilla.components.lib.fetch.okhttp/-ok-http-client/fetch.md create mode 100644 docs/api/mozilla.components.lib.fetch.okhttp/-ok-http-client/index.md create mode 100644 docs/api/mozilla.components.lib.fetch.okhttp/-request-builder.md create mode 100644 docs/api/mozilla.components.lib.fetch.okhttp/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/-init-.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/alternate.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/arguments.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/consequent.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/equals.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/expression.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/from.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/left.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/name.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/operator.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/relative.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/right.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/subject.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/test.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/to-string.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/type.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-node/value.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-type/-a-r-r-a-y_-l-i-t-e-r-a-l.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-type/-b-i-n-a-r-y_-e-x-p-r-e-s-s-i-o-n.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-type/-c-o-n-d-i-t-i-o-n-a-l_-e-x-p-r-e-s-s-i-o-n.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-type/-f-i-l-t-e-r_-e-x-p-r-e-s-s-i-o-n.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-type/-i-d-e-n-t-i-f-i-e-r.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-type/-l-i-t-e-r-a-l.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-type/-o-b-j-e-c-t_-l-i-t-e-r-a-l.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-type/-t-r-a-n-s-f-o-r-m.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-type/-u-n-a-r-y_-e-x-p-r-e-s-s-i-o-n.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/-ast-type/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.ast/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.evaluator/-jexl-context/-init-.md create mode 100644 docs/api/mozilla.components.lib.jexl.evaluator/-jexl-context/get.md create mode 100644 docs/api/mozilla.components.lib.jexl.evaluator/-jexl-context/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.evaluator/-jexl-context/set.md create mode 100644 docs/api/mozilla.components.lib.jexl.evaluator/-transform.md create mode 100644 docs/api/mozilla.components.lib.jexl.evaluator/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.ext/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.ext/kotlin.-boolean/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.ext/kotlin.-boolean/to-jexl.md create mode 100644 docs/api/mozilla.components.lib.jexl.ext/kotlin.-double/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.ext/kotlin.-double/to-jexl.md create mode 100644 docs/api/mozilla.components.lib.jexl.ext/kotlin.-float/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.ext/kotlin.-float/to-jexl.md create mode 100644 docs/api/mozilla.components.lib.jexl.ext/kotlin.-int/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.ext/kotlin.-int/to-jexl.md create mode 100644 docs/api/mozilla.components.lib.jexl.ext/kotlin.-string/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.ext/kotlin.-string/to-jexl.md create mode 100644 docs/api/mozilla.components.lib.jexl.ext/kotlin.collections.-list/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.ext/kotlin.collections.-list/to-jexl-array.md create mode 100644 docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/-init-.md create mode 100644 docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/evaluate.md create mode 100644 docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/precedence.md create mode 100644 docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/type.md create mode 100644 docs/api/mozilla.components.lib.jexl.grammar/-grammar/-init-.md create mode 100644 docs/api/mozilla.components.lib.jexl.grammar/-grammar/elements.md create mode 100644 docs/api/mozilla.components.lib.jexl.grammar/-grammar/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.grammar/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/-init-.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-b-i-n-a-r-y_-o-p.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-l-o-s-e_-b-r-a-c-k-e-t.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-l-o-s-e_-c-u-r-l.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-l-o-s-e_-p-a-r-e-n.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-o-l-o-n.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-o-m-m-a.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-d-o-t.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-i-d-e-n-t-i-f-i-e-r.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-l-i-t-e-r-a-l.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-o-p-e-n_-b-r-a-c-k-e-t.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-o-p-e-n_-c-u-r-l.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-o-p-e-n_-p-a-r-e-n.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-p-i-p-e.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-q-u-e-s-t-i-o-n.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-u-n-a-r-y_-o-p.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/-type/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/raw.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/type.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/-token/value.md create mode 100644 docs/api/mozilla.components.lib.jexl.lexer/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.parser/-parser-exception/-init-.md create mode 100644 docs/api/mozilla.components.lib.jexl.parser/-parser-exception/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.parser/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-array/-init-.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-array/compare-to.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-array/div.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-array/equals.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-array/hash-code.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-array/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-array/plus.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-array/times.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-array/to-boolean.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-array/to-string.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-array/value.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/-init-.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/compare-to.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/div.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/equals.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/hash-code.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/plus.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/times.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/to-boolean.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/to-int.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/to-string.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/value.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-double/-init-.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-double/compare-to.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-double/div.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-double/equals.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-double/hash-code.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-double/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-double/plus.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-double/times.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-double/to-boolean.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-double/to-string.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-double/value.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-integer/-init-.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-integer/compare-to.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-integer/div.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-integer/equals.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-integer/hash-code.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-integer/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-integer/plus.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-integer/times.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-integer/to-boolean.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-integer/to-string.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-integer/value.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-object/-init-.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-object/compare-to.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-object/div.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-object/equals.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-object/hash-code.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-object/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-object/plus.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-object/times.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-object/to-boolean.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-object/to-string.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-object/value.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-string/-init-.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-string/compare-to.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-string/div.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-string/equals.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-string/hash-code.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-string/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-string/plus.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-string/times.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-string/to-boolean.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-string/to-string.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-string/value.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/-init-.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/compare-to.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/div.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/equals.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/hash-code.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/plus.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/times.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/to-boolean.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/to-string.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/value.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-value/compare-to.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-value/div.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-value/index.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-value/plus.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-value/times.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-value/to-boolean.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/-jexl-value/value.md create mode 100644 docs/api/mozilla.components.lib.jexl.value/index.md create mode 100644 docs/api/mozilla.components.lib.jexl/-jexl-exception/-init-.md create mode 100644 docs/api/mozilla.components.lib.jexl/-jexl-exception/index.md create mode 100644 docs/api/mozilla.components.lib.jexl/-jexl/-init-.md create mode 100644 docs/api/mozilla.components.lib.jexl/-jexl/add-transform.md create mode 100644 docs/api/mozilla.components.lib.jexl/-jexl/evaluate-boolean-expression.md create mode 100644 docs/api/mozilla.components.lib.jexl/-jexl/evaluate.md create mode 100644 docs/api/mozilla.components.lib.jexl/-jexl/index.md create mode 100644 docs/api/mozilla.components.lib.jexl/index.md create mode 100644 docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/-init-.md create mode 100644 docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/get-public-suffix-plus-one.md create mode 100644 docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/get-public-suffix.md create mode 100644 docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/index.md create mode 100644 docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/is-public-suffix.md create mode 100644 docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/prefetch.md create mode 100644 docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/strip-public-suffix.md create mode 100644 docs/api/mozilla.components.lib.publicsuffixlist/index.md create mode 100644 docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/-init-.md create mode 100644 docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/index.md create mode 100644 docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/schedule.md create mode 100644 docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/-init-.md create mode 100644 docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/get-fretboard.md create mode 100644 docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/index.md create mode 100644 docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/on-start-job.md create mode 100644 docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/on-stop-job.md create mode 100644 docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/index.md create mode 100644 docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-sync-worker/-init-.md create mode 100644 docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-sync-worker/do-work.md create mode 100644 docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-sync-worker/fretboard.md create mode 100644 docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-sync-worker/index.md create mode 100644 docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-work-manager-sync-scheduler/-init-.md create mode 100644 docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-work-manager-sync-scheduler/index.md create mode 100644 docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-work-manager-sync-scheduler/schedule.md create mode 100644 docs/api/mozilla.components.service.fretboard.scheduler.workmanager/index.md create mode 100644 docs/api/mozilla.components.service.fretboard.source.kinto/-http-client/get.md create mode 100644 docs/api/mozilla.components.service.fretboard.source.kinto/-http-client/index.md create mode 100644 docs/api/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/-init-.md create mode 100644 docs/api/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/get-experiments.md create mode 100644 docs/api/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/index.md create mode 100644 docs/api/mozilla.components.service.fretboard.source.kinto/index.md create mode 100644 docs/api/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/-init-.md create mode 100644 docs/api/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/index.md create mode 100644 docs/api/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/retrieve.md create mode 100644 docs/api/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/save.md create mode 100644 docs/api/mozilla.components.service.fretboard.storage.flatfile/index.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-descriptor/-init-.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-descriptor/index.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-descriptor/name.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-download-exception/-init-.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-download-exception/index.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-payload/-init-.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-payload/get-boolean-list.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-payload/get-double-list.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-payload/get-int-list.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-payload/get-keys.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-payload/get-long-list.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-payload/get-string-list.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-payload/get.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-payload/index.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-payload/put.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-source/get-experiments.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-source/index.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-storage/index.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-storage/retrieve.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment-storage/save.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/-bucket/-init-.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/-bucket/index.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/-bucket/max.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/-bucket/min.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/-init-.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/-matcher/-init-.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/-matcher/app-id.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/-matcher/country.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/-matcher/device.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/-matcher/index.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/-matcher/language.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/-matcher/manufacturer.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/-matcher/regions.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/-matcher/release-channel.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/-matcher/version.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/bucket.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/description.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/equals.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/hash-code.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/index.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/last-modified.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/match.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/name.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/payload.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiment/schema.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiments-snapshot/-init-.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiments-snapshot/experiments.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiments-snapshot/index.md create mode 100644 docs/api/mozilla.components.service.fretboard/-experiments-snapshot/last-modified.md create mode 100644 docs/api/mozilla.components.service.fretboard/-fretboard/-init-.md create mode 100644 docs/api/mozilla.components.service.fretboard/-fretboard/clear-all-overrides-now.md create mode 100644 docs/api/mozilla.components.service.fretboard/-fretboard/clear-all-overrides.md create mode 100644 docs/api/mozilla.components.service.fretboard/-fretboard/clear-override-now.md create mode 100644 docs/api/mozilla.components.service.fretboard/-fretboard/clear-override.md create mode 100644 docs/api/mozilla.components.service.fretboard/-fretboard/experiments.md create mode 100644 docs/api/mozilla.components.service.fretboard/-fretboard/get-active-experiments.md create mode 100644 docs/api/mozilla.components.service.fretboard/-fretboard/get-experiment.md create mode 100644 docs/api/mozilla.components.service.fretboard/-fretboard/get-experiments-map.md create mode 100644 docs/api/mozilla.components.service.fretboard/-fretboard/get-user-bucket.md create mode 100644 docs/api/mozilla.components.service.fretboard/-fretboard/index.md create mode 100644 docs/api/mozilla.components.service.fretboard/-fretboard/is-in-experiment.md create mode 100644 docs/api/mozilla.components.service.fretboard/-fretboard/load-experiments.md create mode 100644 docs/api/mozilla.components.service.fretboard/-fretboard/set-override-now.md create mode 100644 docs/api/mozilla.components.service.fretboard/-fretboard/set-override.md create mode 100644 docs/api/mozilla.components.service.fretboard/-fretboard/update-experiments.md create mode 100644 docs/api/mozilla.components.service.fretboard/-fretboard/with-experiment.md create mode 100644 docs/api/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/-init-.md create mode 100644 docs/api/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/from-json.md create mode 100644 docs/api/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/index.md create mode 100644 docs/api/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/to-json.md create mode 100644 docs/api/mozilla.components.service.fretboard/-values-provider/-init-.md create mode 100644 docs/api/mozilla.components.service.fretboard/-values-provider/get-app-id.md create mode 100644 docs/api/mozilla.components.service.fretboard/-values-provider/get-client-id.md create mode 100644 docs/api/mozilla.components.service.fretboard/-values-provider/get-country.md create mode 100644 docs/api/mozilla.components.service.fretboard/-values-provider/get-device.md create mode 100644 docs/api/mozilla.components.service.fretboard/-values-provider/get-language.md create mode 100644 docs/api/mozilla.components.service.fretboard/-values-provider/get-manufacturer.md create mode 100644 docs/api/mozilla.components.service.fretboard/-values-provider/get-region.md create mode 100644 docs/api/mozilla.components.service.fretboard/-values-provider/get-release-channel.md create mode 100644 docs/api/mozilla.components.service.fretboard/-values-provider/get-version.md create mode 100644 docs/api/mozilla.components.service.fretboard/-values-provider/index.md create mode 100644 docs/api/mozilla.components.service.fretboard/index.md create mode 100644 docs/api/mozilla.components.service.fxa/-access-token-info/-init-.md create mode 100644 docs/api/mozilla.components.service.fxa/-access-token-info/expires-at.md create mode 100644 docs/api/mozilla.components.service.fxa/-access-token-info/index.md create mode 100644 docs/api/mozilla.components.service.fxa/-access-token-info/key.md create mode 100644 docs/api/mozilla.components.service.fxa/-access-token-info/token.md create mode 100644 docs/api/mozilla.components.service.fxa/-account-observer/index.md create mode 100644 docs/api/mozilla.components.service.fxa/-account-observer/on-authenticated.md create mode 100644 docs/api/mozilla.components.service.fxa/-account-observer/on-error.md create mode 100644 docs/api/mozilla.components.service.fxa/-account-observer/on-logged-out.md create mode 100644 docs/api/mozilla.components.service.fxa/-account-observer/on-profile-updated.md create mode 100644 docs/api/mozilla.components.service.fxa/-account-state/-authenticated-no-profile.md create mode 100644 docs/api/mozilla.components.service.fxa/-account-state/-authenticated-with-profile.md create mode 100644 docs/api/mozilla.components.service.fxa/-account-state/-not-authenticated.md create mode 100644 docs/api/mozilla.components.service.fxa/-account-state/-start.md create mode 100644 docs/api/mozilla.components.service.fxa/-account-state/index.md create mode 100644 docs/api/mozilla.components.service.fxa/-account-storage/clear.md create mode 100644 docs/api/mozilla.components.service.fxa/-account-storage/index.md create mode 100644 docs/api/mozilla.components.service.fxa/-account-storage/read.md create mode 100644 docs/api/mozilla.components.service.fxa/-account-storage/write.md create mode 100644 docs/api/mozilla.components.service.fxa/-avatar/-init-.md create mode 100644 docs/api/mozilla.components.service.fxa/-avatar/index.md create mode 100644 docs/api/mozilla.components.service.fxa/-avatar/is-default.md create mode 100644 docs/api/mozilla.components.service.fxa/-avatar/url.md create mode 100644 docs/api/mozilla.components.service.fxa/-config.md create mode 100644 docs/api/mozilla.components.service.fxa/-f-x-a_-s-t-a-t-e_-k-e-y.md create mode 100644 docs/api/mozilla.components.service.fxa/-f-x-a_-s-t-a-t-e_-p-r-e-f-s_-k-e-y.md create mode 100644 docs/api/mozilla.components.service.fxa/-failed-to-load-account-exception/-init-.md create mode 100644 docs/api/mozilla.components.service.fxa/-failed-to-load-account-exception/index.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account-shaped/begin-o-auth-flow.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account-shaped/begin-pairing-flow.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account-shaped/complete-o-auth-flow.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account-shaped/get-access-token.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account-shaped/get-profile.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account-shaped/get-token-server-endpoint-u-r-l.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account-shaped/index.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account-shaped/to-j-s-o-n-string.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account/-init-.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account/begin-o-auth-flow.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account/begin-pairing-flow.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account/close.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account/complete-o-auth-flow.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account/from-j-s-o-n-string.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account/get-access-token.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account/get-connection-success-u-r-l.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account/get-profile.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account/get-token-server-endpoint-u-r-l.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account/index.md create mode 100644 docs/api/mozilla.components.service.fxa/-firefox-account/to-j-s-o-n-string.md create mode 100644 docs/api/mozilla.components.service.fxa/-fxa-account-manager/-init-.md create mode 100644 docs/api/mozilla.components.service.fxa/-fxa-account-manager/account-profile.md create mode 100644 docs/api/mozilla.components.service.fxa/-fxa-account-manager/authenticated-account.md create mode 100644 docs/api/mozilla.components.service.fxa/-fxa-account-manager/begin-authentication.md create mode 100644 docs/api/mozilla.components.service.fxa/-fxa-account-manager/close.md create mode 100644 docs/api/mozilla.components.service.fxa/-fxa-account-manager/create-account.md create mode 100644 docs/api/mozilla.components.service.fxa/-fxa-account-manager/finish-authentication.md create mode 100644 docs/api/mozilla.components.service.fxa/-fxa-account-manager/index.md create mode 100644 docs/api/mozilla.components.service.fxa/-fxa-account-manager/init.md create mode 100644 docs/api/mozilla.components.service.fxa/-fxa-account-manager/logout.md create mode 100644 docs/api/mozilla.components.service.fxa/-fxa-account-manager/update-profile.md create mode 100644 docs/api/mozilla.components.service.fxa/-fxa-exception.md create mode 100644 docs/api/mozilla.components.service.fxa/-fxa-network-exception.md create mode 100644 docs/api/mozilla.components.service.fxa/-fxa-panic-exception.md create mode 100644 docs/api/mozilla.components.service.fxa/-fxa-unauthorized-exception.md create mode 100644 docs/api/mozilla.components.service.fxa/-fxa-unspecified-exception.md create mode 100644 docs/api/mozilla.components.service.fxa/-o-auth-scoped-key/-init-.md create mode 100644 docs/api/mozilla.components.service.fxa/-o-auth-scoped-key/index.md create mode 100644 docs/api/mozilla.components.service.fxa/-o-auth-scoped-key/k.md create mode 100644 docs/api/mozilla.components.service.fxa/-o-auth-scoped-key/kid.md create mode 100644 docs/api/mozilla.components.service.fxa/-profile/-init-.md create mode 100644 docs/api/mozilla.components.service.fxa/-profile/avatar.md create mode 100644 docs/api/mozilla.components.service.fxa/-profile/display-name.md create mode 100644 docs/api/mozilla.components.service.fxa/-profile/email.md create mode 100644 docs/api/mozilla.components.service.fxa/-profile/index.md create mode 100644 docs/api/mozilla.components.service.fxa/-profile/uid.md create mode 100644 docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/-init-.md create mode 100644 docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/clear.md create mode 100644 docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/context.md create mode 100644 docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/index.md create mode 100644 docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/read.md create mode 100644 docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/write.md create mode 100644 docs/api/mozilla.components.service.fxa/index.md create mode 100644 docs/api/mozilla.components.service.glean.config/-configuration/-init-.md create mode 100644 docs/api/mozilla.components.service.glean.config/-configuration/connection-timeout.md create mode 100644 docs/api/mozilla.components.service.glean.config/-configuration/index.md create mode 100644 docs/api/mozilla.components.service.glean.config/-configuration/log-pings.md create mode 100644 docs/api/mozilla.components.service.glean.config/-configuration/max-events.md create mode 100644 docs/api/mozilla.components.service.glean.config/-configuration/read-timeout.md create mode 100644 docs/api/mozilla.components.service.glean.config/-configuration/server-endpoint.md create mode 100644 docs/api/mozilla.components.service.glean.config/-configuration/user-agent.md create mode 100644 docs/api/mozilla.components.service.glean.config/index.md create mode 100644 docs/api/mozilla.components.service.glean.storages/-recorded-event-data/-init-.md create mode 100644 docs/api/mozilla.components.service.glean.storages/-recorded-event-data/category.md create mode 100644 docs/api/mozilla.components.service.glean.storages/-recorded-event-data/extra.md create mode 100644 docs/api/mozilla.components.service.glean.storages/-recorded-event-data/index.md create mode 100644 docs/api/mozilla.components.service.glean.storages/-recorded-event-data/ms-since-start.md create mode 100644 docs/api/mozilla.components.service.glean.storages/-recorded-event-data/name.md create mode 100644 docs/api/mozilla.components.service.glean.storages/-recorded-event-data/object-id.md create mode 100644 docs/api/mozilla.components.service.glean.storages/-recorded-event-data/value.md create mode 100644 docs/api/mozilla.components.service.glean.storages/index.md create mode 100644 docs/api/mozilla.components.service.glean/-boolean-metric-type/-init-.md create mode 100644 docs/api/mozilla.components.service.glean/-boolean-metric-type/category.md create mode 100644 docs/api/mozilla.components.service.glean/-boolean-metric-type/default-storage-destinations.md create mode 100644 docs/api/mozilla.components.service.glean/-boolean-metric-type/disabled.md create mode 100644 docs/api/mozilla.components.service.glean/-boolean-metric-type/index.md create mode 100644 docs/api/mozilla.components.service.glean/-boolean-metric-type/lifetime.md create mode 100644 docs/api/mozilla.components.service.glean/-boolean-metric-type/name.md create mode 100644 docs/api/mozilla.components.service.glean/-boolean-metric-type/send-in-pings.md create mode 100644 docs/api/mozilla.components.service.glean/-boolean-metric-type/set.md create mode 100644 docs/api/mozilla.components.service.glean/-boolean-metric-type/test-get-value.md create mode 100644 docs/api/mozilla.components.service.glean/-boolean-metric-type/test-has-value.md create mode 100644 docs/api/mozilla.components.service.glean/-common-metric-data/category.md create mode 100644 docs/api/mozilla.components.service.glean/-common-metric-data/default-storage-destinations.md create mode 100644 docs/api/mozilla.components.service.glean/-common-metric-data/disabled.md create mode 100644 docs/api/mozilla.components.service.glean/-common-metric-data/get-storage-names.md create mode 100644 docs/api/mozilla.components.service.glean/-common-metric-data/identifier.md create mode 100644 docs/api/mozilla.components.service.glean/-common-metric-data/index.md create mode 100644 docs/api/mozilla.components.service.glean/-common-metric-data/lifetime.md create mode 100644 docs/api/mozilla.components.service.glean/-common-metric-data/name.md create mode 100644 docs/api/mozilla.components.service.glean/-common-metric-data/send-in-pings.md create mode 100644 docs/api/mozilla.components.service.glean/-common-metric-data/should-record.md create mode 100644 docs/api/mozilla.components.service.glean/-counter-metric-type/-init-.md create mode 100644 docs/api/mozilla.components.service.glean/-counter-metric-type/add.md create mode 100644 docs/api/mozilla.components.service.glean/-counter-metric-type/category.md create mode 100644 docs/api/mozilla.components.service.glean/-counter-metric-type/default-storage-destinations.md create mode 100644 docs/api/mozilla.components.service.glean/-counter-metric-type/disabled.md create mode 100644 docs/api/mozilla.components.service.glean/-counter-metric-type/index.md create mode 100644 docs/api/mozilla.components.service.glean/-counter-metric-type/lifetime.md create mode 100644 docs/api/mozilla.components.service.glean/-counter-metric-type/name.md create mode 100644 docs/api/mozilla.components.service.glean/-counter-metric-type/send-in-pings.md create mode 100644 docs/api/mozilla.components.service.glean/-counter-metric-type/test-get-value.md create mode 100644 docs/api/mozilla.components.service.glean/-counter-metric-type/test-has-value.md create mode 100644 docs/api/mozilla.components.service.glean/-event-metric-type/-init-.md create mode 100644 docs/api/mozilla.components.service.glean/-event-metric-type/allowed-extra-keys.md create mode 100644 docs/api/mozilla.components.service.glean/-event-metric-type/category.md create mode 100644 docs/api/mozilla.components.service.glean/-event-metric-type/default-storage-destinations.md create mode 100644 docs/api/mozilla.components.service.glean/-event-metric-type/disabled.md create mode 100644 docs/api/mozilla.components.service.glean/-event-metric-type/index.md create mode 100644 docs/api/mozilla.components.service.glean/-event-metric-type/lifetime.md create mode 100644 docs/api/mozilla.components.service.glean/-event-metric-type/name.md create mode 100644 docs/api/mozilla.components.service.glean/-event-metric-type/objects.md create mode 100644 docs/api/mozilla.components.service.glean/-event-metric-type/record.md create mode 100644 docs/api/mozilla.components.service.glean/-event-metric-type/send-in-pings.md create mode 100644 docs/api/mozilla.components.service.glean/-event-metric-type/test-get-value.md create mode 100644 docs/api/mozilla.components.service.glean/-event-metric-type/test-has-value.md create mode 100644 docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/get-upload-enabled.md create mode 100644 docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/handle-event.md create mode 100644 docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/index.md create mode 100644 docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/initialize.md create mode 100644 docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/set-experiment-active.md create mode 100644 docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/set-experiment-inactive.md create mode 100644 docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/set-upload-enabled.md create mode 100644 docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/test-clear-all-data.md create mode 100644 docs/api/mozilla.components.service.glean/-glean/-ping-event/-background.md create mode 100644 docs/api/mozilla.components.service.glean/-glean/-ping-event/-default.md create mode 100644 docs/api/mozilla.components.service.glean/-glean/-ping-event/index.md create mode 100644 docs/api/mozilla.components.service.glean/-glean/index.md create mode 100644 docs/api/mozilla.components.service.glean/-lifetime/-application.md create mode 100644 docs/api/mozilla.components.service.glean/-lifetime/-ping.md create mode 100644 docs/api/mozilla.components.service.glean/-lifetime/-user.md create mode 100644 docs/api/mozilla.components.service.glean/-lifetime/index.md create mode 100644 docs/api/mozilla.components.service.glean/-string-list-metric-type/-init-.md create mode 100644 docs/api/mozilla.components.service.glean/-string-list-metric-type/-m-a-x_-s-t-r-i-n-g_-l-e-n-g-t-h.md create mode 100644 docs/api/mozilla.components.service.glean/-string-list-metric-type/add.md create mode 100644 docs/api/mozilla.components.service.glean/-string-list-metric-type/category.md create mode 100644 docs/api/mozilla.components.service.glean/-string-list-metric-type/default-storage-destinations.md create mode 100644 docs/api/mozilla.components.service.glean/-string-list-metric-type/disabled.md create mode 100644 docs/api/mozilla.components.service.glean/-string-list-metric-type/index.md create mode 100644 docs/api/mozilla.components.service.glean/-string-list-metric-type/lifetime.md create mode 100644 docs/api/mozilla.components.service.glean/-string-list-metric-type/name.md create mode 100644 docs/api/mozilla.components.service.glean/-string-list-metric-type/send-in-pings.md create mode 100644 docs/api/mozilla.components.service.glean/-string-list-metric-type/set.md create mode 100644 docs/api/mozilla.components.service.glean/-string-list-metric-type/test-get-value.md create mode 100644 docs/api/mozilla.components.service.glean/-string-list-metric-type/test-has-value.md create mode 100644 docs/api/mozilla.components.service.glean/-string-metric-type/-init-.md create mode 100644 docs/api/mozilla.components.service.glean/-string-metric-type/category.md create mode 100644 docs/api/mozilla.components.service.glean/-string-metric-type/default-storage-destinations.md create mode 100644 docs/api/mozilla.components.service.glean/-string-metric-type/disabled.md create mode 100644 docs/api/mozilla.components.service.glean/-string-metric-type/index.md create mode 100644 docs/api/mozilla.components.service.glean/-string-metric-type/lifetime.md create mode 100644 docs/api/mozilla.components.service.glean/-string-metric-type/name.md create mode 100644 docs/api/mozilla.components.service.glean/-string-metric-type/send-in-pings.md create mode 100644 docs/api/mozilla.components.service.glean/-string-metric-type/set.md create mode 100644 docs/api/mozilla.components.service.glean/-string-metric-type/test-get-value.md create mode 100644 docs/api/mozilla.components.service.glean/-string-metric-type/test-has-value.md create mode 100644 docs/api/mozilla.components.service.glean/-time-unit/-day.md create mode 100644 docs/api/mozilla.components.service.glean/-time-unit/-hour.md create mode 100644 docs/api/mozilla.components.service.glean/-time-unit/-microsecond.md create mode 100644 docs/api/mozilla.components.service.glean/-time-unit/-millisecond.md create mode 100644 docs/api/mozilla.components.service.glean/-time-unit/-minute.md create mode 100644 docs/api/mozilla.components.service.glean/-time-unit/-nanosecond.md create mode 100644 docs/api/mozilla.components.service.glean/-time-unit/-second.md create mode 100644 docs/api/mozilla.components.service.glean/-time-unit/index.md create mode 100644 docs/api/mozilla.components.service.glean/-timespan-metric-type/-init-.md create mode 100644 docs/api/mozilla.components.service.glean/-timespan-metric-type/cancel.md create mode 100644 docs/api/mozilla.components.service.glean/-timespan-metric-type/category.md create mode 100644 docs/api/mozilla.components.service.glean/-timespan-metric-type/default-storage-destinations.md create mode 100644 docs/api/mozilla.components.service.glean/-timespan-metric-type/disabled.md create mode 100644 docs/api/mozilla.components.service.glean/-timespan-metric-type/index.md create mode 100644 docs/api/mozilla.components.service.glean/-timespan-metric-type/lifetime.md create mode 100644 docs/api/mozilla.components.service.glean/-timespan-metric-type/name.md create mode 100644 docs/api/mozilla.components.service.glean/-timespan-metric-type/send-in-pings.md create mode 100644 docs/api/mozilla.components.service.glean/-timespan-metric-type/start.md create mode 100644 docs/api/mozilla.components.service.glean/-timespan-metric-type/stop-and-sum.md create mode 100644 docs/api/mozilla.components.service.glean/-timespan-metric-type/test-get-value.md create mode 100644 docs/api/mozilla.components.service.glean/-timespan-metric-type/test-has-value.md create mode 100644 docs/api/mozilla.components.service.glean/-timespan-metric-type/time-unit.md create mode 100644 docs/api/mozilla.components.service.glean/-uuid-metric-type/-init-.md create mode 100644 docs/api/mozilla.components.service.glean/-uuid-metric-type/category.md create mode 100644 docs/api/mozilla.components.service.glean/-uuid-metric-type/default-storage-destinations.md create mode 100644 docs/api/mozilla.components.service.glean/-uuid-metric-type/disabled.md create mode 100644 docs/api/mozilla.components.service.glean/-uuid-metric-type/generate-and-set.md create mode 100644 docs/api/mozilla.components.service.glean/-uuid-metric-type/index.md create mode 100644 docs/api/mozilla.components.service.glean/-uuid-metric-type/lifetime.md create mode 100644 docs/api/mozilla.components.service.glean/-uuid-metric-type/name.md create mode 100644 docs/api/mozilla.components.service.glean/-uuid-metric-type/send-in-pings.md create mode 100644 docs/api/mozilla.components.service.glean/-uuid-metric-type/set.md create mode 100644 docs/api/mozilla.components.service.glean/-uuid-metric-type/test-get-value.md create mode 100644 docs/api/mozilla.components.service.glean/-uuid-metric-type/test-has-value.md create mode 100644 docs/api/mozilla.components.service.glean/index.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/-init-.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/add.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/close.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/delete.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/ensure-locked.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/ensure-unlocked.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/for-database.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/get.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/in-memory.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/index.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/is-locked.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/list.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/lock.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/sync.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/touch.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/unlock.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/update.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/wipe-local.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/wipe.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage/add.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage/delete.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage/ensure-locked.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage/ensure-unlocked.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage/get.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage/index.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage/is-locked.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage/list.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage/lock.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage/sync.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage/touch.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage/unlock.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage/update.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage/wipe-local.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-async-logins-storage/wipe.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-id-collision-exception.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-invalid-key-exception.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-invalid-record-exception.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-logins-storage-exception.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-mismatched-lock-exception.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-no-such-record-exception.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-request-failed-exception.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-server-password.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-sync-auth-invalid-exception.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-sync-unlock-info.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/-init-.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/index.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/key.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/store.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/sync.md create mode 100644 docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/with-unlocked.md create mode 100644 docs/api/mozilla.components.service.sync.logins/index.md create mode 100644 docs/api/mozilla.components.support.base.android/-padding/-init-.md create mode 100644 docs/api/mozilla.components.support.base.android/-padding/bottom.md create mode 100644 docs/api/mozilla.components.support.base.android/-padding/index.md create mode 100644 docs/api/mozilla.components.support.base.android/-padding/left.md create mode 100644 docs/api/mozilla.components.support.base.android/-padding/right.md create mode 100644 docs/api/mozilla.components.support.base.android/-padding/top.md create mode 100644 docs/api/mozilla.components.support.base.android/index.md create mode 100644 docs/api/mozilla.components.support.base.facts.processor/-log-fact-processor/-init-.md create mode 100644 docs/api/mozilla.components.support.base.facts.processor/-log-fact-processor/index.md create mode 100644 docs/api/mozilla.components.support.base.facts.processor/-log-fact-processor/process.md create mode 100644 docs/api/mozilla.components.support.base.facts.processor/index.md create mode 100644 docs/api/mozilla.components.support.base.facts/-action/-c-l-i-c-k.md create mode 100644 docs/api/mozilla.components.support.base.facts/-action/-c-o-m-m-i-t.md create mode 100644 docs/api/mozilla.components.support.base.facts/-action/-i-n-t-e-r-a-c-t-i-o-n.md create mode 100644 docs/api/mozilla.components.support.base.facts/-action/-t-o-g-g-l-e.md create mode 100644 docs/api/mozilla.components.support.base.facts/-action/index.md create mode 100644 docs/api/mozilla.components.support.base.facts/-fact-processor/index.md create mode 100644 docs/api/mozilla.components.support.base.facts/-fact-processor/process.md create mode 100644 docs/api/mozilla.components.support.base.facts/-fact/-init-.md create mode 100644 docs/api/mozilla.components.support.base.facts/-fact/action.md create mode 100644 docs/api/mozilla.components.support.base.facts/-fact/component.md create mode 100644 docs/api/mozilla.components.support.base.facts/-fact/index.md create mode 100644 docs/api/mozilla.components.support.base.facts/-fact/item.md create mode 100644 docs/api/mozilla.components.support.base.facts/-fact/metadata.md create mode 100644 docs/api/mozilla.components.support.base.facts/-fact/value.md create mode 100644 docs/api/mozilla.components.support.base.facts/-facts/collect.md create mode 100644 docs/api/mozilla.components.support.base.facts/-facts/index.md create mode 100644 docs/api/mozilla.components.support.base.facts/-facts/register-processor.md create mode 100644 docs/api/mozilla.components.support.base.facts/collect.md create mode 100644 docs/api/mozilla.components.support.base.facts/index.md create mode 100644 docs/api/mozilla.components.support.base.facts/register.md create mode 100644 docs/api/mozilla.components.support.base.feature/-back-handler/index.md create mode 100644 docs/api/mozilla.components.support.base.feature/-back-handler/on-back-pressed.md create mode 100644 docs/api/mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md create mode 100644 docs/api/mozilla.components.support.base.feature/-lifecycle-aware-feature/start.md create mode 100644 docs/api/mozilla.components.support.base.feature/-lifecycle-aware-feature/stop.md create mode 100644 docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/-init-.md create mode 100644 docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/clear.md create mode 100644 docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/get.md create mode 100644 docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/index.md create mode 100644 docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/on-back-pressed.md create mode 100644 docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/set.md create mode 100644 docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/with-feature.md create mode 100644 docs/api/mozilla.components.support.base.feature/index.md create mode 100644 docs/api/mozilla.components.support.base.log.logger/-logger/-init-.md create mode 100644 docs/api/mozilla.components.support.base.log.logger/-logger/debug.md create mode 100644 docs/api/mozilla.components.support.base.log.logger/-logger/error.md create mode 100644 docs/api/mozilla.components.support.base.log.logger/-logger/index.md create mode 100644 docs/api/mozilla.components.support.base.log.logger/-logger/info.md create mode 100644 docs/api/mozilla.components.support.base.log.logger/-logger/measure.md create mode 100644 docs/api/mozilla.components.support.base.log.logger/-logger/warn.md create mode 100644 docs/api/mozilla.components.support.base.log.logger/index.md create mode 100644 docs/api/mozilla.components.support.base.log.sink/-android-log-sink/-init-.md create mode 100644 docs/api/mozilla.components.support.base.log.sink/-android-log-sink/index.md create mode 100644 docs/api/mozilla.components.support.base.log.sink/-android-log-sink/log.md create mode 100644 docs/api/mozilla.components.support.base.log.sink/-log-sink/index.md create mode 100644 docs/api/mozilla.components.support.base.log.sink/-log-sink/log.md create mode 100644 docs/api/mozilla.components.support.base.log.sink/index.md create mode 100644 docs/api/mozilla.components.support.base.observer/-consumable-stream/append.md create mode 100644 docs/api/mozilla.components.support.base.observer/-consumable-stream/consume-all-by.md create mode 100644 docs/api/mozilla.components.support.base.observer/-consumable-stream/consume-all.md create mode 100644 docs/api/mozilla.components.support.base.observer/-consumable-stream/consume-next-by.md create mode 100644 docs/api/mozilla.components.support.base.observer/-consumable-stream/consume-next.md create mode 100644 docs/api/mozilla.components.support.base.observer/-consumable-stream/index.md create mode 100644 docs/api/mozilla.components.support.base.observer/-consumable-stream/is-consumed.md create mode 100644 docs/api/mozilla.components.support.base.observer/-consumable-stream/is-empty.md create mode 100644 docs/api/mozilla.components.support.base.observer/-consumable-stream/remove-consumed.md create mode 100644 docs/api/mozilla.components.support.base.observer/-consumable-stream/remove.md create mode 100644 docs/api/mozilla.components.support.base.observer/-consumable/consume-by.md create mode 100644 docs/api/mozilla.components.support.base.observer/-consumable/consume.md create mode 100644 docs/api/mozilla.components.support.base.observer/-consumable/empty.md create mode 100644 docs/api/mozilla.components.support.base.observer/-consumable/from.md create mode 100644 docs/api/mozilla.components.support.base.observer/-consumable/index.md create mode 100644 docs/api/mozilla.components.support.base.observer/-consumable/is-consumed.md create mode 100644 docs/api/mozilla.components.support.base.observer/-consumable/stream.md create mode 100644 docs/api/mozilla.components.support.base.observer/-observable/index.md create mode 100644 docs/api/mozilla.components.support.base.observer/-observable/notify-observers.md create mode 100644 docs/api/mozilla.components.support.base.observer/-observable/pause-observer.md create mode 100644 docs/api/mozilla.components.support.base.observer/-observable/register.md create mode 100644 docs/api/mozilla.components.support.base.observer/-observable/resume-observer.md create mode 100644 docs/api/mozilla.components.support.base.observer/-observable/unregister-observers.md create mode 100644 docs/api/mozilla.components.support.base.observer/-observable/unregister.md create mode 100644 docs/api/mozilla.components.support.base.observer/-observable/wrap-consumers.md create mode 100644 docs/api/mozilla.components.support.base.observer/-observer-registry/-init-.md create mode 100644 docs/api/mozilla.components.support.base.observer/-observer-registry/index.md create mode 100644 docs/api/mozilla.components.support.base.observer/-observer-registry/notify-observers.md create mode 100644 docs/api/mozilla.components.support.base.observer/-observer-registry/pause-observer.md create mode 100644 docs/api/mozilla.components.support.base.observer/-observer-registry/register.md create mode 100644 docs/api/mozilla.components.support.base.observer/-observer-registry/resume-observer.md create mode 100644 docs/api/mozilla.components.support.base.observer/-observer-registry/unregister-observers.md create mode 100644 docs/api/mozilla.components.support.base.observer/-observer-registry/unregister.md create mode 100644 docs/api/mozilla.components.support.base.observer/-observer-registry/wrap-consumers.md create mode 100644 docs/api/mozilla.components.support.base.observer/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.arch.lifecycle/android.arch.lifecycle.-lifecycle/add-observers.md create mode 100644 docs/api/mozilla.components.support.ktx.android.arch.lifecycle/android.arch.lifecycle.-lifecycle/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.arch.lifecycle/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.content.res/android.content.res.-asset-manager/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.content.res/android.content.res.-asset-manager/read-j-s-o-n-object.md create mode 100644 docs/api/mozilla.components.support.ktx.android.content.res/android.content.res.-resources/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.content.res/android.content.res.-resources/px-to-dp.md create mode 100644 docs/api/mozilla.components.support.ktx.android.content.res/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.content/android.content.-context/app-version-name.md create mode 100644 docs/api/mozilla.components.support.ktx.android.content/android.content.-context/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.content/android.content.-context/is-o-s-on-low-memory.md create mode 100644 docs/api/mozilla.components.support.ktx.android.content/android.content.-context/is-permission-granted.md create mode 100644 docs/api/mozilla.components.support.ktx.android.content/android.content.-context/share.md create mode 100644 docs/api/mozilla.components.support.ktx.android.content/android.content.-context/system-service.md create mode 100644 docs/api/mozilla.components.support.ktx.android.content/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.graphics.drawable/android.graphics.drawable.-drawable/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.graphics.drawable/android.graphics.drawable.-drawable/to-bitmap.md create mode 100644 docs/api/mozilla.components.support.ktx.android.graphics.drawable/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/to-data-uri.md create mode 100644 docs/api/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/with-rounded-corners.md create mode 100644 docs/api/mozilla.components.support.ktx.android.graphics/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.org.json/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.org.json/kotlin.collections.-map/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.org.json/kotlin.collections.-map/to-j-s-o-n.md create mode 100644 docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/as-sequence.md create mode 100644 docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/to-list.md create mode 100644 docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/merge-with.md create mode 100644 docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/put-if-not-null.md create mode 100644 docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/sort-keys.md create mode 100644 docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-int.md create mode 100644 docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-long.md create mode 100644 docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-string.md create mode 100644 docs/api/mozilla.components.support.ktx.android.os/android.os.-strict-mode.-thread-policy/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.os/android.os.-strict-mode.-thread-policy/reset-after.md create mode 100644 docs/api/mozilla.components.support.ktx.android.os/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.util/-base64/encode-to-uri-string.md create mode 100644 docs/api/mozilla.components.support.ktx.android.util/-base64/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.util/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.view/android.app.-activity/enter-to-immersive-mode.md create mode 100644 docs/api/mozilla.components.support.ktx.android.view/android.app.-activity/exit-immersive-mode-if-needed.md create mode 100644 docs/api/mozilla.components.support.ktx.android.view/android.app.-activity/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md create mode 100644 docs/api/mozilla.components.support.ktx.android.view/android.view.-view-group/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md create mode 100644 docs/api/mozilla.components.support.ktx.android.view/android.view.-view/index.md create mode 100644 docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md create mode 100644 docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md create mode 100644 docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md create mode 100644 docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md create mode 100644 docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md create mode 100644 docs/api/mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md create mode 100644 docs/api/mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md create mode 100644 docs/api/mozilla.components.support.ktx.android.view/index.md create mode 100644 docs/api/mozilla.components.support.ktx.kotlin/index.md create mode 100644 docs/api/mozilla.components.support.ktx.kotlin/kotlin.-char/-e-l-l-i-p-s-i-s.md create mode 100644 docs/api/mozilla.components.support.ktx.kotlin/kotlin.-char/index.md create mode 100644 docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/index.md create mode 100644 docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/is-email.md create mode 100644 docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/is-geo-location.md create mode 100644 docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/is-phone.md create mode 100644 docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/is-url.md create mode 100644 docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/to-date.md create mode 100644 docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/to-normalized-url.md create mode 100644 docs/api/mozilla.components.support.ktx.kotlin/kotlin.collections.-map/index.md create mode 100644 docs/api/mozilla.components.support.ktx.kotlin/kotlin.collections.-map/to-bundle.md create mode 100644 docs/api/mozilla.components.support.rustlog/-rust-log/disable.md create mode 100644 docs/api/mozilla.components.support.rustlog/-rust-log/enable.md create mode 100644 docs/api/mozilla.components.support.rustlog/-rust-log/index.md create mode 100644 docs/api/mozilla.components.support.rustlog/-rust-log/set-max-level.md create mode 100644 docs/api/mozilla.components.support.rustlog/index.md create mode 100644 docs/api/mozilla.components.support.test.robolectric/grant-permission.md create mode 100644 docs/api/mozilla.components.support.test.robolectric/index.md create mode 100644 docs/api/mozilla.components.support.test/-k-argument-captor/-init-.md create mode 100644 docs/api/mozilla.components.support.test/-k-argument-captor/all-values.md create mode 100644 docs/api/mozilla.components.support.test/-k-argument-captor/capture.md create mode 100644 docs/api/mozilla.components.support.test/-k-argument-captor/index.md create mode 100644 docs/api/mozilla.components.support.test/-k-argument-captor/value.md create mode 100644 docs/api/mozilla.components.support.test/any.md create mode 100644 docs/api/mozilla.components.support.test/argument-captor.md create mode 100644 docs/api/mozilla.components.support.test/create-instance.md create mode 100644 docs/api/mozilla.components.support.test/eq.md create mode 100644 docs/api/mozilla.components.support.test/expect-exception.md create mode 100644 docs/api/mozilla.components.support.test/index.md create mode 100644 docs/api/mozilla.components.support.test/mock-motion-event.md create mode 100644 docs/api/mozilla.components.support.test/mock.md create mode 100644 docs/api/mozilla.components.support.utils/-color-utils/get-readable-text-color.md create mode 100644 docs/api/mozilla.components.support.utils/-color-utils/index.md create mode 100644 docs/api/mozilla.components.support.utils/-domain-match/-init-.md create mode 100644 docs/api/mozilla.components.support.utils/-domain-match/index.md create mode 100644 docs/api/mozilla.components.support.utils/-domain-match/matched-segment.md create mode 100644 docs/api/mozilla.components.support.utils/-domain-match/url.md create mode 100644 docs/api/mozilla.components.support.utils/-download-utils/guess-file-name.md create mode 100644 docs/api/mozilla.components.support.utils/-download-utils/index.md create mode 100644 docs/api/mozilla.components.support.utils/-drawable-utils/index.md create mode 100644 docs/api/mozilla.components.support.utils/-drawable-utils/load-and-tint-drawable.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-bundle/-init-.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-bundle/get-parcelable.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-bundle/get-string.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-bundle/index.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/-init-.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/action.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/categories.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/data-string.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/data.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/extras.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/flags.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/get-boolean-extra.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/get-bundle-extra.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/get-char-sequence-extra.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/get-int-extra.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/get-parcelable-array-list-extra.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/get-parcelable-extra.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/get-string-array-list-extra.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/get-string-extra.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/has-extra.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/index.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/is-launcher-intent.md create mode 100644 docs/api/mozilla.components.support.utils/-safe-intent/unsafe.md create mode 100644 docs/api/mozilla.components.support.utils/-status-bar-utils/get-status-bar-height.md create mode 100644 docs/api/mozilla.components.support.utils/-status-bar-utils/index.md create mode 100644 docs/api/mozilla.components.support.utils/-thread-utils/assert-on-ui-thread.md create mode 100644 docs/api/mozilla.components.support.utils/-thread-utils/index.md create mode 100644 docs/api/mozilla.components.support.utils/-thread-utils/post-to-background-thread.md create mode 100644 docs/api/mozilla.components.support.utils/-thread-utils/post-to-main-thread-delayed.md create mode 100644 docs/api/mozilla.components.support.utils/-thread-utils/post-to-main-thread.md create mode 100644 docs/api/mozilla.components.support.utils/-thread-utils/set-handler-for-test.md create mode 100644 docs/api/mozilla.components.support.utils/-web-u-r-l-finder/-init-.md create mode 100644 docs/api/mozilla.components.support.utils/-web-u-r-l-finder/best-web-u-r-l.md create mode 100644 docs/api/mozilla.components.support.utils/-web-u-r-l-finder/index.md create mode 100644 docs/api/mozilla.components.support.utils/index.md create mode 100644 docs/api/mozilla.components.support.utils/segment-aware-domain-match.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/-init-.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/create-new-client.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/create-web-server.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-overriding-default-headers.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-default-headers.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-duplicated-cache-control-request-headers.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-duplicated-cache-control-response-headers.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-gzipped-body.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-headers.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-read-timeout.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-string-body.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-user-agent.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get302-follow-redirects-disabled.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get302-follow-redirects.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get404-with-body.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/index.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/post200-with-body.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/put201-file-upload.md create mode 100644 docs/api/mozilla.components.tooling.fetch.tests/index.md create mode 100644 docs/api/mozilla.components.tooling.lint/-lint-issue-registry/-init-.md create mode 100644 docs/api/mozilla.components.tooling.lint/-lint-issue-registry/api.md create mode 100644 docs/api/mozilla.components.tooling.lint/-lint-issue-registry/index.md create mode 100644 docs/api/mozilla.components.tooling.lint/-lint-issue-registry/issues.md create mode 100644 docs/api/mozilla.components.tooling.lint/-lint-log-checks/-init-.md create mode 100644 docs/api/mozilla.components.tooling.lint/-lint-log-checks/get-applicable-method-names.md create mode 100644 docs/api/mozilla.components.tooling.lint/-lint-log-checks/index.md create mode 100644 docs/api/mozilla.components.tooling.lint/-lint-log-checks/issues.md create mode 100644 docs/api/mozilla.components.tooling.lint/-lint-log-checks/visit-method.md create mode 100644 docs/api/mozilla.components.tooling.lint/index.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-autocomplete-view/apply-autocomplete-result.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-autocomplete-view/index.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-autocomplete-view/no-autocomplete-result.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-autocomplete-view/original-text.md create mode 100644 docs/api/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 create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/-init-.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/index.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/source.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/starts-with.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/text.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/total-items.md create mode 100644 docs/api/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 create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-i-n-p-u-t_-m-e-t-h-o-d_-a-m-a-z-o-n_-e-c-h-o_-s-h-o-w.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-i-n-p-u-t_-m-e-t-h-o-d_-s-o-n-y.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-init-.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/apply-autocomplete-result.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/autocomplete-result.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/get-text.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/index.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/no-autocomplete-result.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/non-autocomplete-text.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-attached-to-window.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-create-input-connection.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-focus-changed.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-key-pre-ime.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-selection-changed.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-touch-event.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-window-focus-changed.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/original-text.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/send-accessibility-event-unchecked.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-commit-listener.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-filter-listener.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-key-pre-ime-listener.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-search-state-change-listener.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-selection-changed-listener.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-text-change-listener.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-windows-focus-change-listener.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-text.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-on-commit-listener.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-on-filter-listener.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-on-key-pre-ime-listener.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-on-search-state-change-listener.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-on-selection-changed-listener.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-on-text-change-listener.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-on-windows-focus-change-listener.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/-text-formatter.md create mode 100644 docs/api/mozilla.components.ui.autocomplete/index.md create mode 100644 docs/api/mozilla.components.ui.doorhanger/-doorhanger/-init-.md create mode 100644 docs/api/mozilla.components.ui.doorhanger/-doorhanger/dismiss.md create mode 100644 docs/api/mozilla.components.ui.doorhanger/-doorhanger/index.md create mode 100644 docs/api/mozilla.components.ui.doorhanger/-doorhanger/show.md create mode 100644 docs/api/mozilla.components.ui.doorhanger/index.md create mode 100644 docs/api/mozilla.components.ui.progress/-animated-progress-bar/-init-.md create mode 100644 docs/api/mozilla.components.ui.progress/-animated-progress-bar/index.md create mode 100644 docs/api/mozilla.components.ui.progress/-animated-progress-bar/on-draw.md create mode 100644 docs/api/mozilla.components.ui.progress/-animated-progress-bar/set-progress.md create mode 100644 docs/api/mozilla.components.ui.progress/-animated-progress-bar/set-visibility.md create mode 100644 docs/api/mozilla.components.ui.progress/index.md create mode 100644 docs/api/mozilla.components.ui.tabcounter/-tab-counter/-init-.md create mode 100644 docs/api/mozilla.components.ui.tabcounter/-tab-counter/get-text.md create mode 100644 docs/api/mozilla.components.ui.tabcounter/-tab-counter/index.md create mode 100644 docs/api/mozilla.components.ui.tabcounter/-tab-counter/set-count-with-animation.md create mode 100644 docs/api/mozilla.components.ui.tabcounter/-tab-counter/set-count.md create mode 100644 docs/api/mozilla.components.ui.tabcounter/index.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-app-name.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-app-version.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-build-id.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-class-load-timestamp-millis.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-connect-timeout.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-context.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-data-directory.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-initial-backoff-for-upload.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-events-per-ping.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-ping-uploads-per-day.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-pings-per-type.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-minimum-events-for-upload.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-preferences-important-for-telemetry.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-read-timeout.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-server-endpoint.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-settings-provider.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-shared-preferences.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-update-channel.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-user-agent.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/index.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/is-collection-enabled.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/is-upload-enabled.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-app-name.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-app-version.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-build-id.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-collection-enabled.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-connect-timeout.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-data-directory.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-initial-backoff-for-upload.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-events-per-ping.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-ping-uploads-per-day.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-pings-per-type.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-minimum-events-for-upload.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-preferences-important-for-telemetry.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-read-timeout.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-server-endpoint.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-settings-provider.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-update-channel.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-upload-enabled.md create mode 100644 docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-user-agent.md create mode 100644 docs/api/org.mozilla.telemetry.config/index.md create mode 100644 docs/api/org.mozilla.telemetry.event/-telemetry-event/create.md create mode 100644 docs/api/org.mozilla.telemetry.event/-telemetry-event/extra.md create mode 100644 docs/api/org.mozilla.telemetry.event/-telemetry-event/index.md create mode 100644 docs/api/org.mozilla.telemetry.event/-telemetry-event/queue.md create mode 100644 docs/api/org.mozilla.telemetry.event/-telemetry-event/to-j-s-o-n.md create mode 100644 docs/api/org.mozilla.telemetry.event/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-arch-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-arch-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-arch-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-client-id-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-client-id-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-client-id-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-created-date-measurement-new/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-created-date-measurement-new/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-created-date-measurement-new/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-created-date-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-created-date-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-created-date-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/get-default-search-engine-identifier.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/set-default-search-engine-provider.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-device-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-device-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-device-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-events-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-events-measurement/add.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-events-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-events-measurement/get-event-count.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-events-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-experiments-map-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-experiments-map-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-experiments-map-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-experiments-map-measurement/set-experiments.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-experiments-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-experiments-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-experiments-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-experiments-measurement/set-active-experiments.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-locale-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-locale-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-locale-measurement/get-language-tag.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-locale-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-metrics-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-metrics-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-metrics-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-operating-system-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-operating-system-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-operating-system-version-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-operating-system-version-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-pocket-id-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-pocket-id-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-pocket-id-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-searches-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-searches-measurement/-l-o-c-a-t-i-o-n_-a-c-t-i-o-n-b-a-r.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-searches-measurement/-l-o-c-a-t-i-o-n_-l-i-s-t-i-t-e-m.md create mode 100644 docs/api/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 create mode 100644 docs/api/org.mozilla.telemetry.measurement/-searches-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-searches-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-searches-measurement/record-search.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-sequence-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-sequence-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-sequence-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-session-count-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-session-count-measurement/count-session.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-session-count-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-session-count-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/record-session-end.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/record-session-start.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/contains-key.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/get-value.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/release.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/update.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/contains-key.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/get-value.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/release.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/update.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-settings-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-settings-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-static-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-static-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-static-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-telemetry-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-telemetry-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-telemetry-measurement/get-field-name.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-telemetry-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-timezone-offset-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-timezone-offset-measurement/flush.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-timezone-offset-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-version-measurement/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/-version-measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.measurement/index.md create mode 100644 docs/api/org.mozilla.telemetry.net/-telemetry-client/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.net/-telemetry-client/index.md create mode 100644 docs/api/org.mozilla.telemetry.net/-telemetry-client/upload-ping.md create mode 100644 docs/api/org.mozilla.telemetry.net/index.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/-t-y-p-e.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-default-search-measurement.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-experiments-measurement.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-searches-measurement.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-session-count-measurement.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-session-duration-measurement.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/index.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/-t-y-p-e.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/can-build.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/get-events-measurement.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/get-experiments-map-measurement.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/index.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/-t-y-p-e.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/can-build.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/get-events-measurement.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/get-experiments-map-measurement.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/index.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/-t-y-p-e.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/index.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/build.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/can-build.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/generate-document-id.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/get-configuration.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/get-type.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/index.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-ping/get-document-id.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-ping/get-measurement-results.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-ping/get-type.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-ping/get-upload-path.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-ping/index.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-pocket-event-ping-builder/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-pocket-event-ping-builder/-t-y-p-e.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-pocket-event-ping-builder/get-events-measurement.md create mode 100644 docs/api/org.mozilla.telemetry.ping/-telemetry-pocket-event-ping-builder/index.md create mode 100644 docs/api/org.mozilla.telemetry.ping/index.md create mode 100644 docs/api/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/index.md create mode 100644 docs/api/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/schedule-upload.md create mode 100644 docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/index.md create mode 100644 docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/on-start-job.md create mode 100644 docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/on-stop-job.md create mode 100644 docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/upload-pings-in-background.md create mode 100644 docs/api/org.mozilla.telemetry.schedule.jobscheduler/index.md create mode 100644 docs/api/org.mozilla.telemetry.schedule/-telemetry-scheduler/index.md create mode 100644 docs/api/org.mozilla.telemetry.schedule/-telemetry-scheduler/schedule-upload.md create mode 100644 docs/api/org.mozilla.telemetry.schedule/index.md create mode 100644 docs/api/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/index.md create mode 100644 docs/api/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/serialize.md create mode 100644 docs/api/org.mozilla.telemetry.serialize/-telemetry-ping-serializer/index.md create mode 100644 docs/api/org.mozilla.telemetry.serialize/-telemetry-ping-serializer/serialize.md create mode 100644 docs/api/org.mozilla.telemetry.serialize/index.md create mode 100644 docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/count-stored-pings.md create mode 100644 docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/index.md create mode 100644 docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/process.md create mode 100644 docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/store.md create mode 100644 docs/api/org.mozilla.telemetry.storage/-telemetry-storage/-telemetry-storage-callback/index.md create mode 100644 docs/api/org.mozilla.telemetry.storage/-telemetry-storage/-telemetry-storage-callback/on-telemetry-ping-loaded.md create mode 100644 docs/api/org.mozilla.telemetry.storage/-telemetry-storage/count-stored-pings.md create mode 100644 docs/api/org.mozilla.telemetry.storage/-telemetry-storage/index.md create mode 100644 docs/api/org.mozilla.telemetry.storage/-telemetry-storage/process.md create mode 100644 docs/api/org.mozilla.telemetry.storage/-telemetry-storage/store.md create mode 100644 docs/api/org.mozilla.telemetry.storage/index.md create mode 100644 docs/api/org.mozilla.telemetry.util/-context-utils/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.util/-context-utils/get-app-name.md create mode 100644 docs/api/org.mozilla.telemetry.util/-context-utils/get-version-code.md create mode 100644 docs/api/org.mozilla.telemetry.util/-context-utils/get-version-name.md create mode 100644 docs/api/org.mozilla.telemetry.util/-context-utils/index.md create mode 100644 docs/api/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/compare.md create mode 100644 docs/api/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/index.md create mode 100644 docs/api/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/accept.md create mode 100644 docs/api/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/index.md create mode 100644 docs/api/org.mozilla.telemetry.util/-file-utils/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.util/-file-utils/assert-directory.md create mode 100644 docs/api/org.mozilla.telemetry.util/-file-utils/index.md create mode 100644 docs/api/org.mozilla.telemetry.util/-i-o-utils/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.util/-i-o-utils/index.md create mode 100644 docs/api/org.mozilla.telemetry.util/-i-o-utils/safe-close.md create mode 100644 docs/api/org.mozilla.telemetry.util/-string-utils/-init-.md create mode 100644 docs/api/org.mozilla.telemetry.util/-string-utils/index.md create mode 100644 docs/api/org.mozilla.telemetry.util/-string-utils/safe-substring.md create mode 100644 docs/api/org.mozilla.telemetry.util/index.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry-holder/-init-.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry-holder/get.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry-holder/index.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry-holder/set.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/-init-.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/add-ping-builder.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/get-builders.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/get-client-id.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/get-client.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/get-configuration.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/get-ping-builder.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/get-storage.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/index.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/queue-event.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/queue-ping.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/record-active-experiments.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/record-experiments.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/record-search.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/record-session-end.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/record-session-start.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/schedule-upload.md create mode 100644 docs/api/org.mozilla.telemetry/-telemetry/set-default-search-provider.md create mode 100644 docs/api/org.mozilla.telemetry/index.md create mode 100644 docs/api/package-list diff --git a/docs/api/alltypes/index.md b/docs/api/alltypes/index.md new file mode 100644 index 00000000000..9ca94263c6f --- /dev/null +++ b/docs/api/alltypes/index.md @@ -0,0 +1,398 @@ + + +### All Types + +| Name | Summary | +|---|---| +| [mozilla.components.feature.customtabs.AbstractCustomTabsService](../mozilla.components.feature.customtabs/-abstract-custom-tabs-service/index.md) | [Service](https://developer.android.com/reference/android/app/Service.html) providing Custom Tabs related functionality. | +| [mozilla.components.service.fxa.AccessTokenInfo](../mozilla.components.service.fxa/-access-token-info/index.md) | The result of authentication with FxA via an OAuth flow. | +| [mozilla.components.service.fxa.AccountObserver](../mozilla.components.service.fxa/-account-observer/index.md) | Observer interface which lets its users monitor account state changes and major events. | +| [mozilla.components.service.fxa.AccountState](../mozilla.components.service.fxa/-account-state/index.md) | | +| [mozilla.components.service.fxa.AccountStorage](../mozilla.components.service.fxa/-account-storage/index.md) | | +| [mozilla.components.support.base.facts.Action](../mozilla.components.support.base.facts/-action/index.md) | A user or system action that causes [Fact](../mozilla.components.support.base.facts/-fact/index.md) instances to be emitted. | +| [android.app.Activity](../mozilla.components.support.ktx.android.view/android.app.-activity/index.md) (extensions in package mozilla.components.support.ktx.android.view) | | +| [mozilla.components.feature.downloads.AndroidDownloadManager](../mozilla.components.feature.downloads/-android-download-manager.md) | | +| [mozilla.components.support.base.log.sink.AndroidLogSink](../mozilla.components.support.base.log.sink/-android-log-sink/index.md) | LogSink implementation that writes to Android's log. | +| [mozilla.components.ui.progress.AnimatedProgressBar](../mozilla.components.ui.progress/-animated-progress-bar/index.md) | An animated progress bar following the Photon Design System. | +| [org.mozilla.telemetry.measurement.ArchMeasurement](../org.mozilla.telemetry.measurement/-arch-measurement/index.md) | | +| [android.content.res.AssetManager](../mozilla.components.support.ktx.android.content.res/android.content.res.-asset-manager/index.md) (extensions in package mozilla.components.support.ktx.android.content.res) | | +| [mozilla.components.browser.search.provider.AssetsSearchEngineProvider](../mozilla.components.browser.search.provider/-assets-search-engine-provider/index.md) | SearchEngineProvider implementation to load the included search engines from assets. | +| [mozilla.components.lib.jexl.ast.AstNode](../mozilla.components.lib.jexl.ast/-ast-node/index.md) | A node of the abstract syntax tree. | +| [mozilla.components.lib.jexl.ast.AstType](../mozilla.components.lib.jexl.ast/-ast-type/index.md) | | +| [mozilla.components.browser.toolbar.AsyncAutocompleteDelegate](../mozilla.components.browser.toolbar/-async-autocomplete-delegate/index.md) | An autocomplete delegate which is aware of its parent scope (to check for cancellations). Responsible for processing autocompletion results and discarding stale results when [urlView](#) moved on. | +| [mozilla.components.browser.toolbar.AsyncFilterListener](../mozilla.components.browser.toolbar/-async-filter-listener/index.md) | Wraps [filter](#) execution in a coroutine context, cancelling prior executions on every invocation. [coroutineContext](../mozilla.components.browser.toolbar/-async-filter-listener/coroutine-context.md) must be of type that doesn't propagate cancellation of its children upwards. | +| [mozilla.components.service.sync.logins.AsyncLoginsStorage](../mozilla.components.service.sync.logins/-async-logins-storage/index.md) | An interface equivalent to the LoginsStorage interface, but where operations are asynchronous. | +| [mozilla.components.service.sync.logins.AsyncLoginsStorageAdapter](../mozilla.components.service.sync.logins/-async-logins-storage-adapter/index.md) | A helper class to wrap a synchronous [LoginsStorage](#) implementation and make it asynchronous. | +| [mozilla.components.feature.sync.AuthException](../mozilla.components.feature.sync/-auth-exception/index.md) | An exception which may happen while obtaining auth information using [FirefoxAccount](../mozilla.components.service.fxa/-firefox-account/index.md). | +| [mozilla.components.feature.sync.AuthExceptionType](../mozilla.components.feature.sync/-auth-exception-type/index.md) | An auth-related exception type, for use with [AuthException](../mozilla.components.feature.sync/-auth-exception/index.md). | +| [mozilla.components.browser.session.storage.AutoSave](../mozilla.components.browser.session.storage/-auto-save/index.md) | | +| [mozilla.components.concept.toolbar.AutocompleteDelegate](../mozilla.components.concept.toolbar/-autocomplete-delegate/index.md) | Describes an object to which a [AutocompleteResult](../mozilla.components.concept.toolbar/-autocomplete-result/index.md) may be applied. Usually, this will delegate to a specific text view. | +| [mozilla.components.concept.toolbar.AutocompleteResult](../mozilla.components.concept.toolbar/-autocomplete-result/index.md) | Describes an autocompletion result. | +| [mozilla.components.ui.autocomplete.AutocompleteView](../mozilla.components.ui.autocomplete/-autocomplete-view/index.md) | Aids in testing functionality which relies on some aspects of InlineAutocompleteEditText. | +| [mozilla.components.service.fxa.Avatar](../mozilla.components.service.fxa/-avatar/index.md) | | +| [mozilla.components.concept.awesomebar.AwesomeBar](../mozilla.components.concept.awesomebar/-awesome-bar/index.md) | Interface to be implemented by awesome bar implementations. | +| [mozilla.components.feature.awesomebar.AwesomeBarFeature](../mozilla.components.feature.awesomebar/-awesome-bar-feature/index.md) | Connects an [AwesomeBar](../mozilla.components.concept.awesomebar/-awesome-bar/index.md) with a [Toolbar](../mozilla.components.concept.toolbar/-toolbar/index.md) and allows adding multiple [AwesomeBar.SuggestionProvider](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementations. | +| [mozilla.components.support.base.feature.BackHandler](../mozilla.components.support.base.feature/-back-handler/index.md) | Generic interface for fragments, features and other components that want to handle 'back' button presses. | +| [mozilla.components.support.ktx.android.util.Base64](../mozilla.components.support.ktx.android.util/-base64/index.md) | | +| [mozilla.components.browser.domains.autocomplete.BaseDomainAutocompleteProvider](../mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/index.md) | Provides common autocomplete functionality powered by domain lists. | +| [android.graphics.Bitmap](../mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/index.md) (extensions in package mozilla.components.support.ktx.android.graphics) | | +| [kotlin.Boolean](../mozilla.components.lib.jexl.ext/kotlin.-boolean/index.md) (extensions in package mozilla.components.lib.jexl.ext) | | +| [mozilla.components.service.glean.BooleanMetricType](../mozilla.components.service.glean/-boolean-metric-type/index.md) | This implements the developer facing API for recording boolean metrics. | +| [mozilla.components.browser.awesomebar.BrowserAwesomeBar](../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md) | A customizable [AwesomeBar](../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation. | +| [mozilla.components.browser.menu.BrowserMenu](../mozilla.components.browser.menu/-browser-menu/index.md) | A popup menu composed of BrowserMenuItem objects. | +| [mozilla.components.browser.menu.BrowserMenuBuilder](../mozilla.components.browser.menu/-browser-menu-builder/index.md) | Helper class for building browser menus. | +| [mozilla.components.browser.menu.item.BrowserMenuCheckbox](../mozilla.components.browser.menu.item/-browser-menu-checkbox/index.md) | A simple browser menu checkbox. | +| [mozilla.components.browser.menu.item.BrowserMenuCompoundButton](../mozilla.components.browser.menu.item/-browser-menu-compound-button/index.md) | A browser menu compound button. A basic sub-class would only have to provide a layout resource to satisfy [BrowserMenuItem.getLayoutResource](../mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md) which contains a [View](https://developer.android.com/reference/android/view/View.html) that inherits from [CompoundButton](https://developer.android.com/reference/android/widget/CompoundButton.html). | +| [mozilla.components.browser.menu.item.BrowserMenuDivider](../mozilla.components.browser.menu.item/-browser-menu-divider/index.md) | A browser menu item to display a horizontal divider. | +| [mozilla.components.browser.menu.item.BrowserMenuImageText](../mozilla.components.browser.menu.item/-browser-menu-image-text/index.md) | A menu item for displaying text with an image icon. | +| [mozilla.components.browser.menu.BrowserMenuItem](../mozilla.components.browser.menu/-browser-menu-item/index.md) | 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.md) | 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.md) | | +| [mozilla.components.browser.menu.item.BrowserMenuSwitch](../mozilla.components.browser.menu.item/-browser-menu-switch/index.md) | A simple browser menu switch. | +| [mozilla.components.browser.tabstray.BrowserTabsTray](../mozilla.components.browser.tabstray/-browser-tabs-tray/index.md) | A customizable tabs tray for browsers. | +| [mozilla.components.browser.toolbar.BrowserToolbar](../mozilla.components.browser.toolbar/-browser-toolbar/index.md) | A customizable toolbar for browsers. | +| [mozilla.components.browser.toolbar.behavior.BrowserToolbarBottomBehavior](../mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/index.md) | A [CoordinatorLayout.Behavior](#) implementation to be used when placing [BrowserToolbar](../mozilla.components.browser.toolbar/-browser-toolbar/index.md) at the bottom of the screen. | +| [mozilla.components.browser.engine.gecko.fetch.ByteBufferInputStream](../mozilla.components.browser.engine.gecko.fetch/-byte-buffer-input-stream/index.md) | | +| [kotlin.Char](../mozilla.components.support.ktx.kotlin/kotlin.-char/index.md) (extensions in package mozilla.components.support.ktx.kotlin) | | +| [mozilla.components.concept.engine.prompt.Choice](../mozilla.components.concept.engine.prompt/-choice/index.md) | Value type that represents a select option, optgroup or menuitem html element. | +| [mozilla.components.concept.fetch.Client](../mozilla.components.concept.fetch/-client/index.md) | A generic [Client](../mozilla.components.concept.fetch/-client/index.md) for fetching resources via HTTP/s. | +| [org.mozilla.telemetry.measurement.ClientIdMeasurement](../org.mozilla.telemetry.measurement/-client-id-measurement/index.md) | A unique, randomly generated UUID for this client. | +| [mozilla.components.feature.awesomebar.provider.ClipboardSuggestionProvider](../mozilla.components.feature.awesomebar.provider/-clipboard-suggestion-provider/index.md) | An [AwesomeBar.SuggestionProvider](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that returns a suggestions for an URL in the clipboard (if there's any). | +| [mozilla.components.support.utils.ColorUtils](../mozilla.components.support.utils/-color-utils/index.md) | | +| [mozilla.components.service.glean.CommonMetricData](../mozilla.components.service.glean/-common-metric-data/index.md) | This defines the common set of data shared across all the different metric types. | +| [mozilla.components.service.fxa.Config](../mozilla.components.service.fxa/-config.md) | | +| [mozilla.components.service.glean.config.Configuration](../mozilla.components.service.glean.config/-configuration/index.md) | The Configuration class describes how to configure the Glean. | +| [mozilla.components.browser.storage.sync.Connection](../mozilla.components.browser.storage.sync/-connection/index.md) | An interface which describes a [Closeable](https://developer.android.com/reference/java/io/Closeable.html) connection that provides access to a [PlacesAPI](#). | +| [mozilla.components.support.base.observer.Consumable](../mozilla.components.support.base.observer/-consumable/index.md) | A generic wrapper for values that can get consumed. | +| [mozilla.components.support.base.observer.ConsumableStream](../mozilla.components.support.base.observer/-consumable-stream/index.md) | A generic wrapper for a stream of values that can be consumed. Values will be consumed first in, first out. | +| [android.content.Context](../mozilla.components.support.ktx.android.content/android.content.-context/index.md) (extensions in package mozilla.components.support.ktx.android.content) | | +| [mozilla.components.feature.contextmenu.ContextMenuCandidate](../mozilla.components.feature.contextmenu/-context-menu-candidate/index.md) | A candidate for an item to be displayed in the context menu. | +| [mozilla.components.feature.contextmenu.ContextMenuFeature](../mozilla.components.feature.contextmenu/-context-menu-feature/index.md) | Feature for displaying a context menu after long-pressing web content. | +| [mozilla.components.feature.contextmenu.ContextMenuFragment](../mozilla.components.feature.contextmenu/-context-menu-fragment/index.md) | [DialogFragment](#) implementation to display the actual context menu dialog. | +| [org.mozilla.telemetry.util.ContextUtils](../org.mozilla.telemetry.util/-context-utils/index.md) | | +| [mozilla.components.feature.session.CoordinateScrollingFeature](../mozilla.components.feature.session/-coordinate-scrolling-feature/index.md) | Feature implementation for connecting an [EngineView](../mozilla.components.concept.engine/-engine-view/index.md) with any View that you want to coordinate scrolling behavior with. | +| [mozilla.components.service.glean.CounterMetricType](../mozilla.components.service.glean/-counter-metric-type/index.md) | This implements the developer facing API for recording counter metrics. | +| [mozilla.components.lib.crash.Crash](../mozilla.components.lib.crash/-crash/index.md) | Crash types that are handled by this library. | +| [mozilla.components.lib.crash.handler.CrashHandlerService](../mozilla.components.lib.crash.handler/-crash-handler-service/index.md) | Service receiving native code crashes (from GeckoView). | +| [mozilla.components.lib.crash.CrashReporter](../mozilla.components.lib.crash/-crash-reporter/index.md) | A generic crash reporter that can report crashes to multiple services. | +| [mozilla.components.lib.crash.prompt.CrashReporterActivity](../mozilla.components.lib.crash.prompt/-crash-reporter-activity/index.md) | Activity showing the crash reporter prompt asking the user for confirmation before submitting a crash report. | +| [mozilla.components.lib.crash.service.CrashReporterService](../mozilla.components.lib.crash.service/-crash-reporter-service/index.md) | Interface to be implemented by external services that accept crash reports. | +| [org.mozilla.telemetry.measurement.CreatedDateMeasurement](../org.mozilla.telemetry.measurement/-created-date-measurement/index.md) | | +| [org.mozilla.telemetry.measurement.CreatedDateMeasurementNew](../org.mozilla.telemetry.measurement/-created-date-measurement-new/index.md) | The field 'created' from CreatedDateMeasurement will be deprecated for the `createdDate` field | +| [org.mozilla.telemetry.measurement.CreatedTimestampMeasurement](../org.mozilla.telemetry.measurement/-created-timestamp-measurement/index.md) | | +| [org.mozilla.telemetry.measurement.CreatedTimestampMeasurementNew](../org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/index.md) | The field 'created' from CreatedTimestampMeasurement will be deprecated for the `createdTimestamp` field | +| [mozilla.components.browser.domains.CustomDomains](../mozilla.components.browser.domains/-custom-domains/index.md) | Contains functionality to manage custom domains for auto-completion. | +| [mozilla.components.browser.domains.autocomplete.CustomDomainsProvider](../mozilla.components.browser.domains.autocomplete/-custom-domains-provider/index.md) | Provides autocomplete functionality for domains based on a list managed by [CustomDomains](../mozilla.components.browser.domains/-custom-domains/index.md). | +| [mozilla.components.browser.session.tab.CustomTabActionButtonConfig](../mozilla.components.browser.session.tab/-custom-tab-action-button-config/index.md) | | +| [mozilla.components.browser.session.tab.CustomTabConfig](../mozilla.components.browser.session.tab/-custom-tab-config/index.md) | Holds configuration data for a Custom Tab. Use [createFromIntent](../mozilla.components.browser.session.tab/-custom-tab-config/create-from-intent.md) to create instances. | +| [mozilla.components.browser.session.tab.CustomTabMenuItem](../mozilla.components.browser.session.tab/-custom-tab-menu-item/index.md) | | +| [mozilla.components.feature.customtabs.CustomTabsToolbarFeature](../mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/index.md) | Initializes and resets the Toolbar for a Custom Tab based on the CustomTabConfig. | +| [org.mozilla.telemetry.measurement.DefaultSearchMeasurement](../org.mozilla.telemetry.measurement/-default-search-measurement/index.md) | | +| [mozilla.components.concept.engine.DefaultSettings](../mozilla.components.concept.engine/-default-settings/index.md) | [Settings](../mozilla.components.concept.engine/-settings/index.md) implementation used to set defaults for [Engine](../mozilla.components.concept.engine/-engine/index.md) and [EngineSession](../mozilla.components.concept.engine/-engine-session/index.md). | +| [mozilla.components.browser.awesomebar.layout.DefaultSuggestionLayout](../mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/index.md) | Default implementation of [SuggestionLayout](../mozilla.components.browser.awesomebar.layout/-suggestion-layout/index.md) to be used by [BrowserAwesomeBar](../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md). | +| [org.mozilla.telemetry.measurement.DeviceMeasurement](../org.mozilla.telemetry.measurement/-device-measurement/index.md) | | +| [mozilla.components.browser.domains.Domain](../mozilla.components.browser.domains/-domain/index.md) | Class intended for internal use which encapsulates meta data about a domain. | +| [mozilla.components.browser.domains.DomainAutoCompleteProvider](../mozilla.components.browser.domains/-domain-auto-complete-provider/index.md) | Provides autocomplete functionality for domains, based on a provided list of assets (see [Domains](../mozilla.components.browser.domains/-domains/index.md)) and/or a custom domain list managed by [CustomDomains](../mozilla.components.browser.domains/-custom-domains/index.md). | +| [mozilla.components.browser.domains.autocomplete.DomainAutocompleteProvider](../mozilla.components.browser.domains.autocomplete/-domain-autocomplete-provider/index.md) | | +| [mozilla.components.browser.domains.autocomplete.DomainAutocompleteResult](../mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/index.md) | Describes an autocompletion result against a list of domains. | +| [mozilla.components.browser.domains.autocomplete.DomainList](../mozilla.components.browser.domains.autocomplete/-domain-list/index.md) | | +| [mozilla.components.support.utils.DomainMatch](../mozilla.components.support.utils/-domain-match/index.md) | | +| [mozilla.components.browser.domains.Domains](../mozilla.components.browser.domains/-domains/index.md) | Contains functionality to access domain lists shipped as part of this module's assets. | +| [mozilla.components.ui.doorhanger.Doorhanger](../mozilla.components.ui.doorhanger/-doorhanger/index.md) | A [Doorhanger](../mozilla.components.ui.doorhanger/-doorhanger/index.md) is a floating heads-up popup that can be anchored to a view. They are presented to notify the user of something that is important. | +| [kotlin.Double](../mozilla.components.lib.jexl.ext/kotlin.-double/index.md) (extensions in package mozilla.components.lib.jexl.ext) | | +| [mozilla.components.browser.session.Download](../mozilla.components.browser.session/-download/index.md) | Value type that represents a Download. | +| [mozilla.components.feature.downloads.DownloadDialogFragment](../mozilla.components.feature.downloads/-download-dialog-fragment/index.md) | This is a general representation of a dialog meant to be used in collaboration with [DownloadsFeature](../mozilla.components.feature.downloads/-downloads-feature/index.md) to show a dialog before a download is triggered. If [SimpleDownloadDialogFragment](../mozilla.components.feature.downloads/-simple-download-dialog-fragment/index.md) is not flexible enough for your use case you should inherit for this class. Be mindful to call [onStartDownload](../mozilla.components.feature.downloads/-download-dialog-fragment/on-start-download.md) when you want to start the download. | +| [mozilla.components.feature.downloads.DownloadManager](../mozilla.components.feature.downloads/-download-manager/index.md) | Handles the interactions with the [AndroidDownloadManager](../mozilla.components.feature.downloads/-android-download-manager.md). | +| [mozilla.components.support.utils.DownloadUtils](../mozilla.components.support.utils/-download-utils/index.md) | | +| [mozilla.components.feature.downloads.DownloadsFeature](../mozilla.components.feature.downloads/-downloads-feature/index.md) | Feature implementation to provide download functionality for the selected session. The feature will subscribe to the selected session and listen for downloads. | +| [android.graphics.drawable.Drawable](../mozilla.components.support.ktx.android.graphics.drawable/android.graphics.drawable.-drawable/index.md) (extensions in package mozilla.components.support.ktx.android.graphics.drawable) | | +| [mozilla.components.support.utils.DrawableUtils](../mozilla.components.support.utils/-drawable-utils/index.md) | | +| [mozilla.components.browser.toolbar.edit.EditToolbar](../mozilla.components.browser.toolbar.edit/-edit-toolbar/index.md) | Sub-component of the browser toolbar responsible for allowing the user to edit the URL. | +| [mozilla.components.concept.engine.Engine](../mozilla.components.concept.engine/-engine/index.md) | Entry point for interacting with the engine implementation. | +| [mozilla.components.concept.engine.EngineSession](../mozilla.components.concept.engine/-engine-session/index.md) | Class representing a single engine session. | +| [mozilla.components.concept.engine.EngineSessionState](../mozilla.components.concept.engine/-engine-session-state/index.md) | The state of an [EngineSession](../mozilla.components.concept.engine/-engine-session/index.md). An instance can be obtained from [EngineSession.saveState](../mozilla.components.concept.engine/-engine-session/save-state.md). Creating a new [EngineSession](../mozilla.components.concept.engine/-engine-session/index.md) and calling [EngineSession.restoreState](../mozilla.components.concept.engine/-engine-session/restore-state.md) with the same state instance should restore the previous session. | +| [mozilla.components.concept.engine.EngineView](../mozilla.components.concept.engine/-engine-view/index.md) | View component that renders web content. | +| [mozilla.components.feature.session.EngineViewPresenter](../mozilla.components.feature.session/-engine-view-presenter/index.md) | Presenter implementation for EngineView. | +| [mozilla.components.browser.errorpages.ErrorPages](../mozilla.components.browser.errorpages/-error-pages/index.md) | | +| [mozilla.components.browser.errorpages.ErrorType](../mozilla.components.browser.errorpages/-error-type/index.md) | Enum containing all supported error types that we can display an error page for. | +| [mozilla.components.service.glean.EventMetricType](../mozilla.components.service.glean/-event-metric-type/index.md) | This implements the developer facing API for recording events. | +| [org.mozilla.telemetry.measurement.EventsMeasurement](../org.mozilla.telemetry.measurement/-events-measurement/index.md) | | +| [mozilla.components.lib.crash.handler.ExceptionHandler](../mozilla.components.lib.crash.handler/-exception-handler/index.md) | [Thread.UncaughtExceptionHandler](https://developer.android.com/reference/java/lang/Thread/UncaughtExceptionHandler.html) implementation that forwards crashes to the [CrashReporter](../mozilla.components.lib.crash/-crash-reporter/index.md) instance. | +| [mozilla.components.service.fretboard.Experiment](../mozilla.components.service.fretboard/-experiment/index.md) | Represents an A/B test experiment, independent of the underlying storage mechanism | +| [mozilla.components.service.fretboard.ExperimentDescriptor](../mozilla.components.service.fretboard/-experiment-descriptor/index.md) | Class used to identify an experiment | +| [mozilla.components.service.fretboard.ExperimentDownloadException](../mozilla.components.service.fretboard/-experiment-download-exception/index.md) | Exception while downloading experiments from the server | +| [mozilla.components.service.fretboard.ExperimentPayload](../mozilla.components.service.fretboard/-experiment-payload/index.md) | Class which represents an experiment associated data | +| [mozilla.components.service.fretboard.ExperimentSource](../mozilla.components.service.fretboard/-experiment-source/index.md) | 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.md) | Represents a location where experiments are stored locally on the device | +| [org.mozilla.telemetry.measurement.ExperimentsMapMeasurement](../org.mozilla.telemetry.measurement/-experiments-map-measurement/index.md) | | +| [org.mozilla.telemetry.measurement.ExperimentsMeasurement](../org.mozilla.telemetry.measurement/-experiments-measurement/index.md) | | +| [mozilla.components.service.fretboard.ExperimentsSnapshot](../mozilla.components.service.fretboard/-experiments-snapshot/index.md) | Represents an experiment sync result | +| [mozilla.components.support.base.facts.Fact](../mozilla.components.support.base.facts/-fact/index.md) | A fact describing a generic event that has occurred in a component. | +| [mozilla.components.support.base.facts.FactProcessor](../mozilla.components.support.base.facts/-fact-processor/index.md) | A [FactProcessor](../mozilla.components.support.base.facts/-fact-processor/index.md) receives [Fact](../mozilla.components.support.base.facts/-fact/index.md) instances to process them further. | +| [mozilla.components.support.base.facts.Facts](../mozilla.components.support.base.facts/-facts/index.md) | Global API for collecting [Fact](../mozilla.components.support.base.facts/-fact/index.md) objects and forwarding them to [FactProcessor](../mozilla.components.support.base.facts/-fact-processor/index.md) instances. | +| [mozilla.components.service.fxa.FailedToLoadAccountException](../mozilla.components.service.fxa/-failed-to-load-account-exception/index.md) | Propagated via [AccountObserver.onError](../mozilla.components.service.fxa/-account-observer/on-error.md) if we fail to load a locally stored account during initialization. No action is necessary from consumers. Account state has been re-initialized. | +| [mozilla.components.tooling.fetch.tests.FetchTestCases](../mozilla.components.tooling.fetch.tests/-fetch-test-cases/index.md) | Generic test cases for concept-fetch implementations. | +| [org.mozilla.telemetry.storage.FileTelemetryStorage](../org.mozilla.telemetry.storage/-file-telemetry-storage/index.md) | TelemetryStorage implementation that stores pings as files on disk. | +| [org.mozilla.telemetry.util.FileUtils](../org.mozilla.telemetry.util/-file-utils/index.md) | | +| [mozilla.components.feature.findinpage.view.FindInPageBar](../mozilla.components.feature.findinpage.view/-find-in-page-bar/index.md) | A customizable "Find in page" bar implementing [FindInPageView](../mozilla.components.feature.findinpage.view/-find-in-page-view/index.md). | +| [mozilla.components.feature.findinpage.FindInPageFeature](../mozilla.components.feature.findinpage/-find-in-page-feature/index.md) | Feature implementation that will keep a [FindInPageView](../mozilla.components.feature.findinpage.view/-find-in-page-view/index.md) in sync with a bound [Session](../mozilla.components.browser.session/-session/index.md). | +| [mozilla.components.feature.findinpage.view.FindInPageView](../mozilla.components.feature.findinpage.view/-find-in-page-view/index.md) | An interface for views that can display "find in page" results and related UI controls. | +| [mozilla.components.service.fxa.FirefoxAccount](../mozilla.components.service.fxa/-firefox-account/index.md) | FirefoxAccount represents the authentication state of a client. | +| [mozilla.components.service.fxa.FirefoxAccountShaped](../mozilla.components.service.fxa/-firefox-account-shaped/index.md) | Facilitates testing consumers of FirefoxAccount. | +| [mozilla.components.feature.accounts.FirefoxAccountsAuthFeature](../mozilla.components.feature.accounts/-firefox-accounts-auth-feature/index.md) | Ties together an account manager with a session manager/tabs implementation, facilitating an authentication flow. | +| [mozilla.components.feature.sync.FirefoxSyncFeature](../mozilla.components.feature.sync/-firefox-sync-feature/index.md) | A feature implementation which orchestrates data synchronization of a set of [SyncableStore](../mozilla.components.concept.storage/-syncable-store/index.md) which all share a common [AuthType](../mozilla.components.feature.sync/-firefox-sync-feature/index.md#AuthType). | +| [org.mozilla.telemetry.measurement.FirstRunProfileDateMeasurement](../org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/index.md) | This measurement will save the timestamp of the first time it was instantiated and report this as profile creation date. | +| [mozilla.components.service.fretboard.storage.flatfile.FlatFileExperimentStorage](../mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/index.md) | Class which uses a flat JSON file as an experiment storage mechanism | +| [kotlin.Float](../mozilla.components.lib.jexl.ext/kotlin.-float/index.md) (extensions in package mozilla.components.lib.jexl.ext) | | +| [mozilla.components.service.fretboard.Fretboard](../mozilla.components.service.fretboard/-fretboard/index.md) | Entry point of the library | +| [mozilla.components.feature.session.FullScreenFeature](../mozilla.components.feature.session/-full-screen-feature/index.md) | Feature implementation for handling fullscreen mode (exiting and back button presses). | +| [mozilla.components.service.fxa.FxaAccountManager](../mozilla.components.service.fxa/-fxa-account-manager/index.md) | An account manager which encapsulates various internal details of an account lifecycle and provides an observer interface along with a public API for interacting with an account. The internal state machine abstracts over state space as exposed by the fxaclient library, not the internal states experienced by lower-level representation of a Firefox Account; those are opaque to us. | +| [mozilla.components.feature.sync.FxaAuthInfo](../mozilla.components.feature.sync/-fxa-auth-info/index.md) | A Firefox Sync friendly auth object which can be obtained from [FirefoxAccount](../mozilla.components.service.fxa/-firefox-account/index.md). | +| [mozilla.components.service.fxa.FxaException](../mozilla.components.service.fxa/-fxa-exception.md) | High-level exception class for the exceptions thrown in the Rust library. | +| [mozilla.components.service.fxa.FxaNetworkException](../mozilla.components.service.fxa/-fxa-network-exception.md) | Thrown on a network error. | +| [mozilla.components.service.fxa.FxaPanicException](../mozilla.components.service.fxa/-fxa-panic-exception.md) | Thrown when the Rust library hits an assertion or panic (this is always a bug). | +| [mozilla.components.service.fxa.FxaUnauthorizedException](../mozilla.components.service.fxa/-fxa-unauthorized-exception.md) | Thrown when the operation requires additional authorization. | +| [mozilla.components.service.fxa.FxaUnspecifiedException](../mozilla.components.service.fxa/-fxa-unspecified-exception.md) | Thrown when the Rust library hits an unexpected error that isn't a panic. This may indicate library misuse, network errors, etc. | +| [mozilla.components.browser.engine.gecko.prompt.GeckoChoice](../mozilla.components.browser.engine.gecko.prompt/-gecko-choice.md) | | +| [mozilla.components.lib.crash.service.GeckoCrashReporter](../mozilla.components.lib.crash.service/-gecko-crash-reporter.md) | | +| [mozilla.components.browser.engine.gecko.GeckoEngine](../mozilla.components.browser.engine.gecko/-gecko-engine/index.md) | Gecko-based implementation of Engine interface. | +| [mozilla.components.browser.engine.gecko.GeckoEngineSession](../mozilla.components.browser.engine.gecko/-gecko-engine-session/index.md) | Gecko-based EngineSession implementation. | +| [mozilla.components.browser.engine.gecko.GeckoEngineSessionState](../mozilla.components.browser.engine.gecko/-gecko-engine-session-state/index.md) | | +| [mozilla.components.browser.engine.gecko.GeckoEngineView](../mozilla.components.browser.engine.gecko/-gecko-engine-view/index.md) | Gecko-based EngineView implementation. | +| [mozilla.components.browser.engine.gecko.permission.GeckoPermissionRequest](../mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/index.md) | Gecko-based implementation of [PermissionRequest](../mozilla.components.concept.engine.permission/-permission-request/index.md). | +| [mozilla.components.browser.engine.gecko.fetch.GeckoViewFetchClient](../mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/index.md) | GeckoView ([GeckoWebExecutor](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoWebExecutor.html)) based implementation of [Client](../mozilla.components.concept.fetch/-client/index.md). | +| [mozilla.components.service.glean.Glean](../mozilla.components.service.glean/-glean/index.md) | | +| [mozilla.components.service.glean.GleanInternalAPI](../mozilla.components.service.glean/-glean-internal-a-p-i/index.md) | | +| [mozilla.components.lib.jexl.grammar.Grammar](../mozilla.components.lib.jexl.grammar/-grammar/index.md) | Grammar of the JEXL language. | +| [mozilla.components.lib.jexl.grammar.GrammarElement](../mozilla.components.lib.jexl.grammar/-grammar-element/index.md) | | +| [mozilla.components.concept.fetch.Header](../mozilla.components.concept.fetch/-header/index.md) | Represents a [Header](../mozilla.components.concept.fetch/-header/index.md) containing of a [name](../mozilla.components.concept.fetch/-header/name.md) and [value](../mozilla.components.concept.fetch/-header/value.md). | +| [mozilla.components.concept.fetch.Headers](../mozilla.components.concept.fetch/-headers/index.md) | A collection of HTTP [Headers](../mozilla.components.concept.fetch/-headers/index.md) (immutable) of a [Request](../mozilla.components.concept.fetch/-request/index.md) or [Response](../mozilla.components.concept.fetch/-response/index.md). | +| [mozilla.components.concept.storage.HistoryAutocompleteResult](../mozilla.components.concept.storage/-history-autocomplete-result/index.md) | Describes an autocompletion result against history storage. | +| [mozilla.components.feature.session.HistoryDelegate](../mozilla.components.feature.session/-history-delegate/index.md) | Implementation of the [HistoryTrackingDelegate](../mozilla.components.concept.engine.history/-history-tracking-delegate/index.md) which delegates work to an instance of [HistoryStorage](../mozilla.components.concept.storage/-history-storage/index.md). | +| [mozilla.components.concept.storage.HistoryStorage](../mozilla.components.concept.storage/-history-storage/index.md) | An interface which defines read/write methods for history data. | +| [mozilla.components.feature.awesomebar.provider.HistoryStorageSuggestionProvider](../mozilla.components.feature.awesomebar.provider/-history-storage-suggestion-provider/index.md) | A [AwesomeBar.SuggestionProvider](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that provides suggestions based on the browsing history stored in the [HistoryStorage](../mozilla.components.concept.storage/-history-storage/index.md). | +| [mozilla.components.concept.engine.history.HistoryTrackingDelegate](../mozilla.components.concept.engine.history/-history-tracking-delegate/index.md) | An interface used for providing history information to an engine (e.g. for link highlighting), and receiving history updates from the engine (visits to URLs, title changes). | +| [mozilla.components.concept.engine.HitResult](../mozilla.components.concept.engine/-hit-result/index.md) | Represents all the different supported types of data that can be found from long clicking an element. | +| [mozilla.components.service.fretboard.source.kinto.HttpClient](../mozilla.components.service.fretboard.source.kinto/-http-client/index.md) | Represents an http client, used to make it easy to swap implementations as needed | +| [mozilla.components.lib.fetch.httpurlconnection.HttpURLConnectionClient](../mozilla.components.lib.fetch.httpurlconnection/-http-u-r-l-connection-client/index.md) | [HttpURLConnection](https://developer.android.com/reference/java/net/HttpURLConnection.html) implementation of [Client](../mozilla.components.concept.fetch/-client/index.md). | +| [org.mozilla.telemetry.util.IOUtils](../org.mozilla.telemetry.util/-i-o-utils/index.md) | | +| [mozilla.components.service.sync.logins.IdCollisionException](../mozilla.components.service.sync.logins/-id-collision-exception.md) | This is thrown if `add()` is given a record whose `id` is not blank, and collides with a record already known to the storage instance. | +| [mozilla.components.browser.storage.memory.InMemoryHistoryStorage](../mozilla.components.browser.storage.memory/-in-memory-history-storage/index.md) | An in-memory implementation of [mozilla.components.concept.storage.HistoryStorage](../mozilla.components.concept.storage/-history-storage/index.md). | +| [mozilla.components.ui.autocomplete.InlineAutocompleteEditText](../mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/index.md) | A UI edit text component which supports inline autocompletion. | +| [kotlin.Int](../mozilla.components.lib.jexl.ext/kotlin.-int/index.md) (extensions in package mozilla.components.lib.jexl.ext) | | +| [mozilla.components.feature.intent.IntentHandler](../mozilla.components.feature.intent/-intent-handler.md) | | +| [mozilla.components.feature.intent.IntentProcessor](../mozilla.components.feature.intent/-intent-processor/index.md) | Processor for intents which should trigger session-related actions. | +| [mozilla.components.service.sync.logins.InvalidKeyException](../mozilla.components.service.sync.logins/-invalid-key-exception.md) | This error is emitted in two cases: | +| [mozilla.components.service.sync.logins.InvalidRecordException](../mozilla.components.service.sync.logins/-invalid-record-exception.md) | This is thrown on attempts to insert or update a record so that it is no longer valid, where "invalid" is defined as such: | +| [org.json.JSONArray](../mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/index.md) (extensions in package mozilla.components.support.ktx.android.org.json) | | +| [mozilla.components.service.fretboard.JSONExperimentParser](../mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/index.md) | Default JSON parsing implementation | +| [org.json.JSONObject](../mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/index.md) (extensions in package mozilla.components.support.ktx.android.org.json) | | +| [org.mozilla.telemetry.serialize.JSONPingSerializer](../org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/index.md) | TelemetryPingSerializer that uses the org.json library provided by the Android system. | +| [mozilla.components.browser.search.suggestions.JSONResponse](../mozilla.components.browser.search.suggestions/-j-s-o-n-response.md) | The Parser is a function that takes a JSON Response and maps it to a Suggestion list. | +| [mozilla.components.lib.jexl.Jexl](../mozilla.components.lib.jexl/-jexl/index.md) | | +| [mozilla.components.lib.jexl.value.JexlArray](../mozilla.components.lib.jexl.value/-jexl-array/index.md) | JEXL Array type. | +| [mozilla.components.lib.jexl.value.JexlBoolean](../mozilla.components.lib.jexl.value/-jexl-boolean/index.md) | JEXL Boolean type. | +| [mozilla.components.lib.jexl.evaluator.JexlContext](../mozilla.components.lib.jexl.evaluator/-jexl-context/index.md) | Variables defined in the [JexlContext](../mozilla.components.lib.jexl.evaluator/-jexl-context/index.md) are available to expressions. | +| [mozilla.components.lib.jexl.value.JexlDouble](../mozilla.components.lib.jexl.value/-jexl-double/index.md) | JEXL Double type. | +| [mozilla.components.lib.jexl.JexlException](../mozilla.components.lib.jexl/-jexl-exception/index.md) | Generic exception thrown when evaluating an expression failed. | +| [mozilla.components.lib.jexl.value.JexlInteger](../mozilla.components.lib.jexl.value/-jexl-integer/index.md) | JEXL Integer type. | +| [mozilla.components.lib.jexl.value.JexlObject](../mozilla.components.lib.jexl.value/-jexl-object/index.md) | JEXL Object type. | +| [mozilla.components.lib.jexl.value.JexlString](../mozilla.components.lib.jexl.value/-jexl-string/index.md) | JEXL String type. | +| [mozilla.components.lib.jexl.value.JexlUndefined](../mozilla.components.lib.jexl.value/-jexl-undefined/index.md) | JEXL undefined type. | +| [mozilla.components.lib.jexl.value.JexlValue](../mozilla.components.lib.jexl.value/-jexl-value/index.md) | A JEXL value type. | +| [mozilla.components.service.fretboard.scheduler.jobscheduler.JobSchedulerSyncScheduler](../mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/index.md) | Class used to schedule sync of experiment configuration from the server | +| [org.mozilla.telemetry.schedule.jobscheduler.JobSchedulerTelemetryScheduler](../org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/index.md) | TelemetryScheduler implementation that uses Android's JobScheduler API to schedule ping uploads. | +| [mozilla.components.support.test.KArgumentCaptor](../mozilla.components.support.test/-k-argument-captor/index.md) | | +| [mozilla.components.lib.dataprotect.KeyStoreWrapper](../mozilla.components.lib.dataprotect/-key-store-wrapper/index.md) | Wraps the critical functions around a Java KeyStore to better facilitate testing and instrumenting. | +| [mozilla.components.lib.dataprotect.Keystore](../mozilla.components.lib.dataprotect/-keystore/index.md) | Manages data protection using a system-isolated cryptographic key. | +| [mozilla.components.lib.dataprotect.KeystoreException](../mozilla.components.lib.dataprotect/-keystore-exception/index.md) | Exception type thrown by {@link Keystore} when an error is encountered that is not otherwise covered by an existing sub-class to `GeneralSecurityException`. | +| [mozilla.components.service.fretboard.source.kinto.KintoExperimentSource](../mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/index.md) | Class responsible for fetching and parsing experiments from a Kinto server | +| [android.arch.lifecycle.Lifecycle](../mozilla.components.support.ktx.android.arch.lifecycle/android.arch.lifecycle.-lifecycle/index.md) (extensions in package mozilla.components.support.ktx.android.arch.lifecycle) | | +| [mozilla.components.support.base.feature.LifecycleAwareFeature](../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md) | An interface for all entry points to feature components to implement in order to make them lifecycle aware. | +| [mozilla.components.concept.engine.LifecycleObserver](../mozilla.components.concept.engine/-lifecycle-observer/index.md) | [LifecycleObserver](#) which dispatches lifecycle events to an [EngineView](../mozilla.components.concept.engine/-engine-view/index.md). | +| [mozilla.components.service.glean.Lifetime](../mozilla.components.service.glean/-lifetime/index.md) | Enumeration of different metric lifetimes. | +| [mozilla.components.tooling.lint.LintIssueRegistry](../mozilla.components.tooling.lint/-lint-issue-registry/index.md) | Registry which provides a list of our custom lint checks to be performed on an Android project. | +| [mozilla.components.tooling.lint.LintLogChecks](../mozilla.components.tooling.lint/-lint-log-checks/index.md) | Custom lint checks related to logging. | +| [kotlin.collections.List](../mozilla.components.lib.jexl.ext/kotlin.collections.-list/index.md) (extensions in package mozilla.components.lib.jexl.ext) | | +| [org.mozilla.telemetry.measurement.LocaleMeasurement](../org.mozilla.telemetry.measurement/-locale-measurement/index.md) | | +| [mozilla.components.browser.search.provider.localization.LocaleSearchLocalizationProvider](../mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/index.md) | LocalizationProvider implementation that only provides the language and country from the system's default languageTag. | +| [mozilla.components.support.base.log.Log](../mozilla.components.support.base.log/-log/index.md) | API for logging messages and exceptions. | +| [mozilla.components.support.base.facts.processor.LogFactProcessor](../mozilla.components.support.base.facts.processor/-log-fact-processor/index.md) | A [FactProcessor](../mozilla.components.support.base.facts/-fact-processor/index.md) implementation that prints collected [Fact](../mozilla.components.support.base.facts/-fact/index.md) instances to the log. | +| [mozilla.components.support.base.log.sink.LogSink](../mozilla.components.support.base.log.sink/-log-sink/index.md) | | +| [mozilla.components.support.base.log.logger.Logger](../mozilla.components.support.base.log.logger/-logger/index.md) | A wrapper for the Log object providing a more convenient API for logging. | +| [mozilla.components.service.sync.logins.LoginsStorageException](../mozilla.components.service.sync.logins/-logins-storage-exception.md) | The base class of all errors emitted by logins storage. | +| [kotlin.collections.Map](../mozilla.components.support.ktx.android.org.json/kotlin.collections.-map/index.md) (extensions in package mozilla.components.support.ktx.android.org.json) | | +| [kotlin.collections.Map](../mozilla.components.support.ktx.kotlin/kotlin.collections.-map/index.md) (extensions in package mozilla.components.support.ktx.kotlin) | | +| [org.mozilla.telemetry.measurement.MetricsMeasurement](../org.mozilla.telemetry.measurement/-metrics-measurement/index.md) | | +| [mozilla.components.service.sync.logins.MismatchedLockException](../mozilla.components.service.sync.logins/-mismatched-lock-exception.md) | This is thrown if `lock()`/`unlock()` pairs don't match up. | +| [mozilla.components.lib.crash.service.MozillaSocorroService](../mozilla.components.lib.crash.service/-mozilla-socorro-service/index.md) | A [CrashReporterService](../mozilla.components.lib.crash.service/-crash-reporter-service/index.md) implementation uploading crash reports to crash-stats.mozilla.com. | +| [mozilla.components.concept.fetch.MutableHeaders](../mozilla.components.concept.fetch/-mutable-headers/index.md) | A collection of HTTP [Headers](../mozilla.components.concept.fetch/-headers/index.md) (mutable) of a [Request](../mozilla.components.concept.fetch/-request/index.md) or [Response](../mozilla.components.concept.fetch/-response/index.md). | +| [mozilla.components.browser.engine.gecko.NestedGeckoView](../mozilla.components.browser.engine.gecko/-nested-gecko-view/index.md) | geckoView that supports nested scrolls (for using in a CoordinatorLayout). | +| [mozilla.components.browser.engine.system.NestedWebView](../mozilla.components.browser.engine.system/-nested-web-view/index.md) | WebView that supports nested scrolls (for using in a CoordinatorLayout). | +| [mozilla.components.service.sync.logins.NoSuchRecordException](../mozilla.components.service.sync.logins/-no-such-record-exception.md) | This is thrown if `update()` is performed with a record whose ID does not exist. | +| [mozilla.components.service.fxa.OAuthScopedKey](../mozilla.components.service.fxa/-o-auth-scoped-key/index.md) | Scoped key data. | +| [mozilla.components.support.base.observer.Observable](../mozilla.components.support.base.observer/-observable/index.md) | 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.md) | 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. | +| [mozilla.components.lib.fetch.okhttp.OkHttpClient](../mozilla.components.lib.fetch.okhttp/-ok-http-client/index.md) | [Client](../mozilla.components.concept.fetch/-client/index.md) implementation using OkHttp. | +| [mozilla.components.ui.autocomplete.OnCommitListener](../mozilla.components.ui.autocomplete/-on-commit-listener.md) | | +| [mozilla.components.feature.downloads.OnDownloadCompleted](../mozilla.components.feature.downloads/-on-download-completed.md) | | +| [mozilla.components.ui.autocomplete.OnFilterListener](../mozilla.components.ui.autocomplete/-on-filter-listener.md) | | +| [mozilla.components.ui.autocomplete.OnKeyPreImeListener](../mozilla.components.ui.autocomplete/-on-key-pre-ime-listener.md) | | +| [mozilla.components.feature.downloads.OnNeedToRequestPermissions](../mozilla.components.feature.downloads/-on-need-to-request-permissions.md) | | +| [mozilla.components.feature.prompts.OnNeedToRequestPermissions](../mozilla.components.feature.prompts/-on-need-to-request-permissions.md) | | +| [mozilla.components.feature.sitepermissions.OnNeedToRequestPermissions](../mozilla.components.feature.sitepermissions/-on-need-to-request-permissions.md) | | +| [mozilla.components.ui.autocomplete.OnSearchStateChangeListener](../mozilla.components.ui.autocomplete/-on-search-state-change-listener.md) | | +| [mozilla.components.ui.autocomplete.OnSelectionChangedListener](../mozilla.components.ui.autocomplete/-on-selection-changed-listener.md) | | +| [mozilla.components.ui.autocomplete.OnTextChangeListener](../mozilla.components.ui.autocomplete/-on-text-change-listener.md) | | +| [mozilla.components.ui.autocomplete.OnWindowsFocusChangeListener](../mozilla.components.ui.autocomplete/-on-windows-focus-change-listener.md) | | +| [org.mozilla.telemetry.measurement.OperatingSystemMeasurement](../org.mozilla.telemetry.measurement/-operating-system-measurement/index.md) | | +| [org.mozilla.telemetry.measurement.OperatingSystemVersionMeasurement](../org.mozilla.telemetry.measurement/-operating-system-version-measurement/index.md) | | +| [mozilla.components.support.base.android.Padding](../mozilla.components.support.base.android/-padding/index.md) | A representation of an Android Padding. | +| [mozilla.components.concept.storage.PageObservation](../mozilla.components.concept.storage/-page-observation/index.md) | | +| [mozilla.components.lib.jexl.parser.ParserException](../mozilla.components.lib.jexl.parser/-parser-exception/index.md) | | +| [mozilla.components.concept.engine.permission.Permission](../mozilla.components.concept.engine.permission/-permission/index.md) | Represents all the different supported permission types. | +| [mozilla.components.concept.engine.permission.PermissionRequest](../mozilla.components.concept.engine.permission/-permission-request/index.md) | Represents a permission request, used when engines need access to protected resources. Every request must be handled by either calling [grant](../mozilla.components.concept.engine.permission/-permission-request/grant.md) or [reject](../mozilla.components.concept.engine.permission/-permission-request/reject.md). | +| [mozilla.components.browser.storage.sync.PlacesHistoryStorage](../mozilla.components.browser.storage.sync/-places-history-storage/index.md) | Implementation of the [HistoryStorage](../mozilla.components.concept.storage/-history-storage/index.md) which is backed by a Rust Places lib via [PlacesConnection](#). | +| [org.mozilla.telemetry.measurement.PocketIdMeasurement](../org.mozilla.telemetry.measurement/-pocket-id-measurement/index.md) | A unique, randomly generated UUID for this pocket client for fire-tv instance. This is distinct from the telemetry clientId. The clientId should not be able to be tied to the pocketId in any way. | +| [org.mozilla.telemetry.measurement.ProcessStartTimestampMeasurement](../org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/index.md) | | +| [mozilla.components.service.fxa.Profile](../mozilla.components.service.fxa/-profile/index.md) | | +| [mozilla.components.feature.prompts.PromptFeature](../mozilla.components.feature.prompts/-prompt-feature/index.md) | Feature for displaying native dialogs for html elements like: input type date, file, time, color, option, menu, authentication, confirmation and alerts. | +| [mozilla.components.concept.engine.prompt.PromptRequest](../mozilla.components.concept.engine.prompt/-prompt-request/index.md) | Value type that represents a request for showing a native dialog for prompt web content. | +| [mozilla.components.lib.publicsuffixlist.PublicSuffixList](../mozilla.components.lib.publicsuffixlist/-public-suffix-list/index.md) | API for reading and accessing the public suffix list. | +| [mozilla.components.service.glean.storages.RecordedEventData](../mozilla.components.service.glean.storages/-recorded-event-data/index.md) | | +| [mozilla.components.concept.fetch.Request](../mozilla.components.concept.fetch/-request/index.md) | The [Request](../mozilla.components.concept.fetch/-request/index.md) data class represents a resource request to be send by a [Client](../mozilla.components.concept.fetch/-client/index.md). | +| [mozilla.components.lib.fetch.okhttp.RequestBuilder](../mozilla.components.lib.fetch.okhttp/-request-builder.md) | | +| [mozilla.components.service.sync.logins.RequestFailedException](../mozilla.components.service.sync.logins/-request-failed-exception.md) | This error is emitted if a request to a sync server failed. | +| [mozilla.components.concept.engine.request.RequestInterceptor](../mozilla.components.concept.engine.request/-request-interceptor/index.md) | Interface for classes that want to intercept load requests to allow custom behavior. | +| [android.content.res.Resources](../mozilla.components.support.ktx.android.content.res/android.content.res.-resources/index.md) (extensions in package mozilla.components.support.ktx.android.content.res) | | +| [mozilla.components.concept.fetch.Response](../mozilla.components.concept.fetch/-response/index.md) | The [Response](../mozilla.components.concept.fetch/-response/index.md) data class represents a reponse to a [Request](../mozilla.components.concept.fetch/-request/index.md) send by a [Client](../mozilla.components.concept.fetch/-client/index.md). | +| [mozilla.components.browser.search.suggestions.ResponseParser](../mozilla.components.browser.search.suggestions/-response-parser.md) | | +| [mozilla.components.browser.engine.system.matcher.ReversibleString](../mozilla.components.browser.engine.system.matcher/-reversible-string/index.md) | 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.support.rustlog.RustLog](../mozilla.components.support.rustlog/-rust-log/index.md) | | +| [mozilla.components.support.utils.SafeBundle](../mozilla.components.support.utils/-safe-bundle/index.md) | 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.md) | External applications can pass values into Intents that can cause us to crash: in defense, we wrap [Intent](https://developer.android.com/reference/android/content/Intent.html) and catch the exceptions they may force us to throw. See bug 1090385 for more. | +| [mozilla.components.browser.search.SearchEngine](../mozilla.components.browser.search/-search-engine/index.md) | A data class representing a search engine. | +| [mozilla.components.browser.search.provider.filter.SearchEngineFilter](../mozilla.components.browser.search.provider.filter/-search-engine-filter/index.md) | 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.md) | This class provides access to a centralized registry of search engines. | +| [mozilla.components.browser.search.SearchEngineParser](../mozilla.components.browser.search/-search-engine-parser/index.md) | A very simple parser for search plugins. | +| [mozilla.components.browser.search.provider.SearchEngineProvider](../mozilla.components.browser.search.provider/-search-engine-provider/index.md) | 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.md) | Class providing language, country and optionally region (actual location) of the user/device to customize the search experience. | +| [mozilla.components.concept.storage.SearchResult](../mozilla.components.concept.storage/-search-result/index.md) | Encapsulates a set of properties which define a result of querying history storage. | +| [mozilla.components.browser.search.suggestions.SearchSuggestionClient](../mozilla.components.browser.search.suggestions/-search-suggestion-client/index.md) | 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.md) | Async function responsible for taking a URL and returning the results | +| [mozilla.components.feature.awesomebar.provider.SearchSuggestionProvider](../mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/index.md) | A [AwesomeBar.SuggestionProvider](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that provides a suggestion containing search engine suggestions (as chips) from the passed in [SearchEngine](../mozilla.components.browser.search/-search-engine/index.md). | +| [mozilla.components.feature.toolbar.SearchUseCase](../mozilla.components.feature.toolbar/-search-use-case.md) | A function representing the search use case, accepting the search terms as string. | +| [mozilla.components.feature.search.SearchUseCases](../mozilla.components.feature.search/-search-use-cases/index.md) | Contains use cases related to the search feature. | +| [org.mozilla.telemetry.measurement.SearchesMeasurement](../org.mozilla.telemetry.measurement/-searches-measurement/index.md) | A TelemetryMeasurement implementation to count the number of times a user has searched with a specific engine from a specific location. | +| [mozilla.components.browser.session.SelectionAwareSessionObserver](../mozilla.components.browser.session/-selection-aware-session-observer/index.md) | This class is a combination of [Session.Observer](../mozilla.components.browser.session/-session/-observer/index.md) and [SessionManager.Observer](../mozilla.components.browser.session/-session-manager/-observer/index.md). It provides functionality to observe changes to a specified or selected session, and can automatically take care of switching over the observer in case a different session gets selected (see [observeFixed](../mozilla.components.browser.session/-selection-aware-session-observer/observe-fixed.md) and [observeSelected](../mozilla.components.browser.session/-selection-aware-session-observer/observe-selected.md)). | +| [mozilla.components.lib.crash.service.SentryService](../mozilla.components.lib.crash.service/-sentry-service/index.md) | A [CrashReporterService](../mozilla.components.lib.crash.service/-crash-reporter-service/index.md) implementation that uploads crash reports to a Sentry server. | +| [org.mozilla.telemetry.measurement.SequenceMeasurement](../org.mozilla.telemetry.measurement/-sequence-measurement/index.md) | | +| [mozilla.components.service.sync.logins.ServerPassword](../mozilla.components.service.sync.logins/-server-password.md) | Raw password data that is stored by the storage implementation. | +| [mozilla.components.browser.engine.servo.ServoEngine](../mozilla.components.browser.engine.servo/-servo-engine/index.md) | Servo-based implementation of the Engine interface. | +| [mozilla.components.browser.engine.servo.ServoEngineSession](../mozilla.components.browser.engine.servo/-servo-engine-session/index.md) | Servo-based EngineSession implementation. | +| [mozilla.components.browser.engine.servo.ServoEngineSessionState](../mozilla.components.browser.engine.servo/-servo-engine-session-state/index.md) | No-op implementation of [EngineSessionState](../mozilla.components.concept.engine/-engine-session-state/index.md). | +| [mozilla.components.browser.engine.servo.ServoEngineView](../mozilla.components.browser.engine.servo/-servo-engine-view/index.md) | Servo-based implementation of EngineView. | +| [mozilla.components.browser.session.Session](../mozilla.components.browser.session/-session/index.md) | Value type that represents the state of a browser session. Changes can be observed. | +| [mozilla.components.feature.session.bundling.SessionBundle](../mozilla.components.feature.session.bundling/-session-bundle/index.md) | A bundle of sessions and their state. | +| [mozilla.components.feature.session.bundling.SessionBundleStorage](../mozilla.components.feature.session.bundling/-session-bundle-storage/index.md) | A [Session](../mozilla.components.browser.session/-session/index.md) storage implementation that saves snapshots as a [SessionBundle](../mozilla.components.feature.session.bundling/-session-bundle/index.md). | +| [org.mozilla.telemetry.measurement.SessionCountMeasurement](../org.mozilla.telemetry.measurement/-session-count-measurement/index.md) | | +| [org.mozilla.telemetry.measurement.SessionDurationMeasurement](../org.mozilla.telemetry.measurement/-session-duration-measurement/index.md) | | +| [mozilla.components.feature.session.SessionFeature](../mozilla.components.feature.session/-session-feature/index.md) | Feature implementation for connecting the engine module with the session module. | +| [mozilla.components.browser.session.SessionManager](../mozilla.components.browser.session/-session-manager/index.md) | 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.md) | Session storage for persisting the state of a [SessionManager](../mozilla.components.browser.session/-session-manager/index.md) to disk (browser and engine session states). | +| [mozilla.components.feature.awesomebar.provider.SessionSuggestionProvider](../mozilla.components.feature.awesomebar.provider/-session-suggestion-provider/index.md) | A [AwesomeBar.SuggestionProvider](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that provides suggestions based on the sessions in the [SessionManager](../mozilla.components.browser.session/-session-manager/index.md) (Open tabs). | +| [mozilla.components.feature.session.SessionUseCases](../mozilla.components.feature.session/-session-use-cases/index.md) | Contains use cases related to the session feature. | +| [mozilla.components.concept.engine.Settings](../mozilla.components.concept.engine/-settings/index.md) | 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. | +| [org.mozilla.telemetry.measurement.SettingsMeasurement](../org.mozilla.telemetry.measurement/-settings-measurement/index.md) | | +| [mozilla.components.service.fxa.SharedPrefAccountStorage](../mozilla.components.service.fxa/-shared-pref-account-storage/index.md) | | +| [mozilla.components.browser.domains.autocomplete.ShippedDomainsProvider](../mozilla.components.browser.domains.autocomplete/-shipped-domains-provider/index.md) | Provides autocomplete functionality for domains based on provided list of assets (see [Domains](../mozilla.components.browser.domains/-domains/index.md)). | +| [mozilla.components.browser.menu.item.SimpleBrowserMenuItem](../mozilla.components.browser.menu.item/-simple-browser-menu-item/index.md) | A simple browser menu item displaying text. | +| [mozilla.components.feature.downloads.SimpleDownloadDialogFragment](../mozilla.components.feature.downloads/-simple-download-dialog-fragment/index.md) | A confirmation dialog to be called before a download is triggered. Meant to be used in collaboration with [DownloadsFeature](../mozilla.components.feature.downloads/-downloads-feature/index.md) | +| [mozilla.components.feature.sitepermissions.SitePermissionsFeature](../mozilla.components.feature.sitepermissions/-site-permissions-feature/index.md) | This feature will subscribe to the currently selected [Session](../mozilla.components.browser.session/-session/index.md) and display a suitable dialogs based on [Session.Observer.onAppPermissionRequested](../mozilla.components.browser.session/-session/-observer/on-app-permission-requested.md) or [Session.Observer.onContentPermissionRequested](../mozilla.components.browser.session/-session/-observer/on-content-permission-requested.md) events. Once the dialog is closed the [PermissionRequest](../mozilla.components.concept.engine.permission/-permission-request/index.md) will be consumed. | +| [mozilla.components.browser.session.storage.SnapshotSerializer](../mozilla.components.browser.session.storage/-snapshot-serializer/index.md) | Helper to transform [SessionManager.Snapshot](../mozilla.components.browser.session/-session-manager/-snapshot/index.md) instances to JSON and back. | +| [org.mozilla.telemetry.measurement.StaticMeasurement](../org.mozilla.telemetry.measurement/-static-measurement/index.md) | | +| [mozilla.components.support.utils.StatusBarUtils](../mozilla.components.support.utils/-status-bar-utils/index.md) | | +| [mozilla.components.feature.sync.StoreSyncStatus](../mozilla.components.feature.sync/-store-sync-status/index.md) | | +| [kotlin.String](../mozilla.components.browser.engine.system.matcher/kotlin.-string/index.md) (extensions in package mozilla.components.browser.engine.system.matcher) | | +| [kotlin.String](../mozilla.components.lib.jexl.ext/kotlin.-string/index.md) (extensions in package mozilla.components.lib.jexl.ext) | | +| [kotlin.String](../mozilla.components.support.ktx.kotlin/kotlin.-string/index.md) (extensions in package mozilla.components.support.ktx.kotlin) | | +| [mozilla.components.service.glean.StringListMetricType](../mozilla.components.service.glean/-string-list-metric-type/index.md) | This implements the developer facing API for recording string list metrics. | +| [mozilla.components.service.glean.StringMetricType](../mozilla.components.service.glean/-string-metric-type/index.md) | This implements the developer facing API for recording string metrics. | +| [org.mozilla.telemetry.util.StringUtils](../org.mozilla.telemetry.util/-string-utils/index.md) | | +| [mozilla.components.browser.awesomebar.layout.SuggestionLayout](../mozilla.components.browser.awesomebar.layout/-suggestion-layout/index.md) | A [SuggestionLayout](../mozilla.components.browser.awesomebar.layout/-suggestion-layout/index.md) implementation defines how the suggestions of the [BrowserAwesomeBar](../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md) are getting layout. By default [BrowserAwesomeBar](../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md) uses [DefaultSuggestionLayout](../mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/index.md). However a consumer can provide its own implementation in order to create a customized look & feel. | +| [mozilla.components.browser.awesomebar.transform.SuggestionTransformer](../mozilla.components.browser.awesomebar.transform/-suggestion-transformer/index.md) | A [SuggestionTransformer](../mozilla.components.browser.awesomebar.transform/-suggestion-transformer/index.md) takes an input list of [AwesomeBar.Suggestion](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md) and returns a new list of transformed [AwesomeBar.Suggestion| objects. | +| [mozilla.components.browser.awesomebar.layout.SuggestionViewHolder](../mozilla.components.browser.awesomebar.layout/-suggestion-view-holder/index.md) | A view holder implementation for displaying an [AwesomeBar.Suggestion](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md). | +| [mozilla.components.browser.storage.sync.SyncAuthInfo](../mozilla.components.browser.storage.sync/-sync-auth-info.md) | | +| [mozilla.components.service.sync.logins.SyncAuthInvalidException](../mozilla.components.service.sync.logins/-sync-auth-invalid-exception.md) | This indicates that the authentication information (e.g. the [SyncUnlockInfo](../mozilla.components.service.sync.logins/-sync-unlock-info.md)) provided to [AsyncLoginsStorage.sync](../mozilla.components.service.sync.logins/-async-logins-storage/sync.md) is invalid. This often indicates that it's stale and should be refreshed with FxA (however, care should be taken not to get into a loop refreshing this information). | +| [mozilla.components.concept.storage.SyncError](../mozilla.components.concept.storage/-sync-error/index.md) | | +| [mozilla.components.service.fretboard.scheduler.jobscheduler.SyncJob](../mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/index.md) | JobScheduler job used to updating the list of experiments | +| [mozilla.components.concept.storage.SyncOk](../mozilla.components.concept.storage/-sync-ok.md) | | +| [mozilla.components.feature.sync.SyncResult](../mozilla.components.feature.sync/-sync-result.md) | A set of results of running a sync operation for all configured stores. | +| [mozilla.components.concept.storage.SyncStatus](../mozilla.components.concept.storage/-sync-status.md) | | +| [mozilla.components.feature.sync.SyncStatusObserver](../mozilla.components.feature.sync/-sync-status-observer/index.md) | An interface for consumers that wish to observer "sync lifecycle" events. | +| [mozilla.components.service.sync.logins.SyncUnlockInfo](../mozilla.components.service.sync.logins/-sync-unlock-info.md) | This type contains the set of information required to successfully connect to the server and sync. | +| [mozilla.components.service.fretboard.scheduler.workmanager.SyncWorker](../mozilla.components.service.fretboard.scheduler.workmanager/-sync-worker/index.md) | | +| [mozilla.components.service.sync.logins.SyncableLoginsStore](../mozilla.components.service.sync.logins/-syncable-logins-store/index.md) | Wraps [AsyncLoginsStorage](../mozilla.components.service.sync.logins/-async-logins-storage/index.md) instance along with a lazy encryption key. | +| [mozilla.components.concept.storage.SyncableStore](../mozilla.components.concept.storage/-syncable-store/index.md) | Describes a "sync" entry point for store which operates over [AuthInfo](../mozilla.components.concept.storage/-syncable-store/index.md#AuthInfo). | +| [mozilla.components.browser.engine.system.SystemEngine](../mozilla.components.browser.engine.system/-system-engine/index.md) | WebView-based implementation of the Engine interface. | +| [mozilla.components.browser.engine.system.SystemEngineSession](../mozilla.components.browser.engine.system/-system-engine-session/index.md) | WebView-based EngineSession implementation. | +| [mozilla.components.browser.engine.system.SystemEngineSessionState](../mozilla.components.browser.engine.system/-system-engine-session-state/index.md) | | +| [mozilla.components.browser.engine.system.SystemEngineView](../mozilla.components.browser.engine.system/-system-engine-view/index.md) | WebView-based implementation of EngineView. | +| [mozilla.components.browser.engine.system.permission.SystemPermissionRequest](../mozilla.components.browser.engine.system.permission/-system-permission-request/index.md) | WebView-based implementation of [PermissionRequest](../mozilla.components.concept.engine.permission/-permission-request/index.md). | +| [mozilla.components.browser.engine.system.window.SystemWindowRequest](../mozilla.components.browser.engine.system.window/-system-window-request/index.md) | WebView-based implementation of [WindowRequest](../mozilla.components.concept.engine.window/-window-request/index.md). | +| [mozilla.components.ui.tabcounter.TabCounter](../mozilla.components.ui.tabcounter/-tab-counter/index.md) | | +| [mozilla.components.feature.tabs.toolbar.TabCounterToolbarButton](../mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/index.md) | A [Toolbar.Action](../mozilla.components.concept.toolbar/-toolbar/-action/index.md) implementation that shows a [TabCounter](../mozilla.components.ui.tabcounter/-tab-counter/index.md). | +| [mozilla.components.browser.tabstray.TabViewHolder](../mozilla.components.browser.tabstray/-tab-view-holder/index.md) | A RecyclerView ViewHolder implementation for "tab" items. | +| [mozilla.components.browser.tabstray.TabsAdapter](../mozilla.components.browser.tabstray/-tabs-adapter/index.md) | RecyclerView adapter implementation to display a list/grid of tabs. | +| [mozilla.components.feature.tabs.tabstray.TabsFeature](../mozilla.components.feature.tabs.tabstray/-tabs-feature/index.md) | 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.md) | Feature implementation for connecting a tabs tray implementation with a toolbar implementation. | +| [mozilla.components.concept.tabstray.TabsTray](../mozilla.components.concept.tabstray/-tabs-tray/index.md) | Generic interface for components that provide "tabs tray" functionality. | +| [mozilla.components.feature.tabs.tabstray.TabsTrayInteractor](../mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/index.md) | 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.md) | 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.md) | Contains use cases related to the tabs feature. | +| [org.mozilla.telemetry.Telemetry](../org.mozilla.telemetry/-telemetry/index.md) | | +| [org.mozilla.telemetry.net.TelemetryClient](../org.mozilla.telemetry.net/-telemetry-client/index.md) | | +| [org.mozilla.telemetry.config.TelemetryConfiguration](../org.mozilla.telemetry.config/-telemetry-configuration/index.md) | 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.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 | +| [org.mozilla.telemetry.event.TelemetryEvent](../org.mozilla.telemetry.event/-telemetry-event/index.md) | 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.md) | A telemetry ping builder for pings of type "focus-event". | +| [org.mozilla.telemetry.TelemetryHolder](../org.mozilla.telemetry/-telemetry-holder/index.md) | 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.md) | | +| [org.mozilla.telemetry.measurement.TelemetryMeasurement](../org.mozilla.telemetry.measurement/-telemetry-measurement/index.md) | | +| [org.mozilla.telemetry.ping.TelemetryMobileEventPingBuilder](../org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/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 | +| [org.mozilla.telemetry.ping.TelemetryMobileMetricsPingBuilder](../org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/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 | +| [org.mozilla.telemetry.ping.TelemetryPing](../org.mozilla.telemetry.ping/-telemetry-ping/index.md) | | +| [org.mozilla.telemetry.ping.TelemetryPingBuilder](../org.mozilla.telemetry.ping/-telemetry-ping-builder/index.md) | | +| [org.mozilla.telemetry.serialize.TelemetryPingSerializer](../org.mozilla.telemetry.serialize/-telemetry-ping-serializer/index.md) | | +| [org.mozilla.telemetry.ping.TelemetryPocketEventPingBuilder](../org.mozilla.telemetry.ping/-telemetry-pocket-event-ping-builder/index.md) | A telemetry ping builder for events of type "fire-tv-events". See the schema for more details: https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/dc458113a7a523e60a9ba50e1174a3b1e0cfdc24/schemas/pocket/fire-tv-events/fire-tv-events.1.schema.json | +| [org.mozilla.telemetry.schedule.TelemetryScheduler](../org.mozilla.telemetry.schedule/-telemetry-scheduler/index.md) | | +| [org.mozilla.telemetry.storage.TelemetryStorage](../org.mozilla.telemetry.storage/-telemetry-storage/index.md) | | +| [mozilla.components.ui.autocomplete.TextFormatter](../mozilla.components.ui.autocomplete/-text-formatter.md) | | +| [android.os.StrictMode.ThreadPolicy](../mozilla.components.support.ktx.android.os/android.os.-strict-mode.-thread-policy/index.md) (extensions in package mozilla.components.support.ktx.android.os) | | +| [mozilla.components.support.utils.ThreadUtils](../mozilla.components.support.utils/-thread-utils/index.md) | | +| [mozilla.components.service.glean.TimeUnit](../mozilla.components.service.glean/-time-unit/index.md) | Enumeration of different resolutions supported by the Timespan metric type. | +| [mozilla.components.service.glean.TimespanMetricType](../mozilla.components.service.glean/-timespan-metric-type/index.md) | This implements the developer facing API for recording timespans. | +| [org.mozilla.telemetry.measurement.TimezoneOffsetMeasurement](../org.mozilla.telemetry.measurement/-timezone-offset-measurement/index.md) | | +| [mozilla.components.lib.jexl.lexer.Token](../mozilla.components.lib.jexl.lexer/-token/index.md) | A token emitted by the [Lexer](#). | +| [mozilla.components.concept.toolbar.Toolbar](../mozilla.components.concept.toolbar/-toolbar/index.md) | Interface to be implemented by components that provide browser toolbar functionality. | +| [mozilla.components.feature.toolbar.ToolbarAutocompleteFeature](../mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/index.md) | Feature implementation for connecting a toolbar with a list of autocomplete providers. | +| [mozilla.components.feature.toolbar.ToolbarFeature](../mozilla.components.feature.toolbar/-toolbar-feature/index.md) | Feature implementation for connecting a toolbar implementation with the session module. | +| [mozilla.components.feature.toolbar.ToolbarInteractor](../mozilla.components.feature.toolbar/-toolbar-interactor/index.md) | Connects a toolbar instance to the browser engine via use cases | +| [mozilla.components.feature.toolbar.ToolbarPresenter](../mozilla.components.feature.toolbar/-toolbar-presenter/index.md) | Presenter implementation for a toolbar implementation in order to update the toolbar whenever the state of the selected session changes. | +| [mozilla.components.lib.jexl.evaluator.Transform](../mozilla.components.lib.jexl.evaluator/-transform.md) | | +| [mozilla.components.browser.engine.system.matcher.Trie](../mozilla.components.browser.engine.system.matcher/-trie/index.md) | Simple implementation of a Trie, used for indexing URLs. | +| [mozilla.components.concept.engine.UnsupportedSetting](../mozilla.components.concept.engine/-unsupported-setting/index.md) | | +| [mozilla.components.concept.engine.UnsupportedSettingException](../mozilla.components.concept.engine/-unsupported-setting-exception/index.md) | Exception thrown by default if a setting is not supported by an engine or session. | +| [mozilla.components.browser.engine.system.matcher.UrlMatcher](../mozilla.components.browser.engine.system.matcher/-url-matcher/index.md) | Provides functionality to process categorized URL black/white lists and match URLs against these lists. | +| [mozilla.components.service.glean.UuidMetricType](../mozilla.components.service.glean/-uuid-metric-type/index.md) | This implements the developer facing API for recording uuids. | +| [mozilla.components.service.fretboard.ValuesProvider](../mozilla.components.service.fretboard/-values-provider/index.md) | Class used to provide custom filter values | +| [org.mozilla.telemetry.measurement.VersionMeasurement](../org.mozilla.telemetry.measurement/-version-measurement/index.md) | | +| [android.view.View](../mozilla.components.support.ktx.android.view/android.view.-view/index.md) (extensions in package mozilla.components.support.ktx.android.view) | | +| [mozilla.components.support.base.feature.ViewBoundFeatureWrapper](../mozilla.components.support.base.feature/-view-bound-feature-wrapper/index.md) | Wrapper for [LifecycleAwareFeature](../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md) instances that keep a strong references to a [View](https://developer.android.com/reference/android/view/View.html). This wrapper is helpful when the lifetime of the [View](https://developer.android.com/reference/android/view/View.html) may be shorter than the [Lifecycle](#) and you need to keep a reference to the [LifecycleAwareFeature](../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md) that may outlive the [View](https://developer.android.com/reference/android/view/View.html). | +| [android.view.ViewGroup](../mozilla.components.support.ktx.android.view/android.view.-view-group/index.md) (extensions in package mozilla.components.support.ktx.android.view) | | +| [mozilla.components.browser.storage.memory.Visit](../mozilla.components.browser.storage.memory/-visit/index.md) | | +| [mozilla.components.concept.storage.VisitType](../mozilla.components.concept.storage/-visit-type/index.md) | Visit type constants as defined by Desktop Firefox. | +| [mozilla.components.support.utils.WebURLFinder](../mozilla.components.support.utils/-web-u-r-l-finder/index.md) | 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 | +| [mozilla.components.feature.session.WindowFeature](../mozilla.components.feature.session/-window-feature/index.md) | Feature implementation for handling window requests. | +| [mozilla.components.concept.engine.window.WindowRequest](../mozilla.components.concept.engine.window/-window-request/index.md) | Represents a request to open or close a browser window. | +| [mozilla.components.service.fretboard.scheduler.workmanager.WorkManagerSyncScheduler](../mozilla.components.service.fretboard.scheduler.workmanager/-work-manager-sync-scheduler/index.md) | Class used to schedule sync of experiment configuration from the server using WorkManager | diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 00000000000..5330a16af1b --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1,136 @@ +[android-components](./index.md) + +### Packages + +| Name | Summary | +|---|---| +| [mozilla.components.browser.awesomebar](mozilla.components.browser.awesomebar/index.md) | | +| [mozilla.components.browser.awesomebar.layout](mozilla.components.browser.awesomebar.layout/index.md) | | +| [mozilla.components.browser.awesomebar.transform](mozilla.components.browser.awesomebar.transform/index.md) | | +| [mozilla.components.browser.domains](mozilla.components.browser.domains/index.md) | | +| [mozilla.components.browser.domains.autocomplete](mozilla.components.browser.domains.autocomplete/index.md) | | +| [mozilla.components.browser.engine.gecko](mozilla.components.browser.engine.gecko/index.md) | | +| [mozilla.components.browser.engine.gecko.fetch](mozilla.components.browser.engine.gecko.fetch/index.md) | | +| [mozilla.components.browser.engine.gecko.permission](mozilla.components.browser.engine.gecko.permission/index.md) | | +| [mozilla.components.browser.engine.gecko.prompt](mozilla.components.browser.engine.gecko.prompt/index.md) | | +| [mozilla.components.browser.engine.servo](mozilla.components.browser.engine.servo/index.md) | | +| [mozilla.components.browser.engine.system](mozilla.components.browser.engine.system/index.md) | | +| [mozilla.components.browser.engine.system.matcher](mozilla.components.browser.engine.system.matcher/index.md) | | +| [mozilla.components.browser.engine.system.permission](mozilla.components.browser.engine.system.permission/index.md) | | +| [mozilla.components.browser.engine.system.window](mozilla.components.browser.engine.system.window/index.md) | | +| [mozilla.components.browser.errorpages](mozilla.components.browser.errorpages/index.md) | | +| [mozilla.components.browser.menu](mozilla.components.browser.menu/index.md) | | +| [mozilla.components.browser.menu.item](mozilla.components.browser.menu.item/index.md) | | +| [mozilla.components.browser.search](mozilla.components.browser.search/index.md) | | +| [mozilla.components.browser.search.provider](mozilla.components.browser.search.provider/index.md) | | +| [mozilla.components.browser.search.provider.filter](mozilla.components.browser.search.provider.filter/index.md) | | +| [mozilla.components.browser.search.provider.localization](mozilla.components.browser.search.provider.localization/index.md) | | +| [mozilla.components.browser.search.suggestions](mozilla.components.browser.search.suggestions/index.md) | | +| [mozilla.components.browser.session](mozilla.components.browser.session/index.md) | | +| [mozilla.components.browser.session.storage](mozilla.components.browser.session.storage/index.md) | | +| [mozilla.components.browser.session.tab](mozilla.components.browser.session.tab/index.md) | | +| [mozilla.components.browser.storage.memory](mozilla.components.browser.storage.memory/index.md) | | +| [mozilla.components.browser.storage.sync](mozilla.components.browser.storage.sync/index.md) | | +| [mozilla.components.browser.tabstray](mozilla.components.browser.tabstray/index.md) | | +| [mozilla.components.browser.toolbar](mozilla.components.browser.toolbar/index.md) | | +| [mozilla.components.browser.toolbar.behavior](mozilla.components.browser.toolbar.behavior/index.md) | | +| [mozilla.components.browser.toolbar.edit](mozilla.components.browser.toolbar.edit/index.md) | | +| [mozilla.components.concept.awesomebar](mozilla.components.concept.awesomebar/index.md) | | +| [mozilla.components.concept.engine](mozilla.components.concept.engine/index.md) | | +| [mozilla.components.concept.engine.history](mozilla.components.concept.engine.history/index.md) | | +| [mozilla.components.concept.engine.permission](mozilla.components.concept.engine.permission/index.md) | | +| [mozilla.components.concept.engine.prompt](mozilla.components.concept.engine.prompt/index.md) | | +| [mozilla.components.concept.engine.request](mozilla.components.concept.engine.request/index.md) | | +| [mozilla.components.concept.engine.window](mozilla.components.concept.engine.window/index.md) | | +| [mozilla.components.concept.fetch](mozilla.components.concept.fetch/index.md) | | +| [mozilla.components.concept.storage](mozilla.components.concept.storage/index.md) | | +| [mozilla.components.concept.tabstray](mozilla.components.concept.tabstray/index.md) | | +| [mozilla.components.concept.toolbar](mozilla.components.concept.toolbar/index.md) | | +| [mozilla.components.feature.accounts](mozilla.components.feature.accounts/index.md) | | +| [mozilla.components.feature.awesomebar](mozilla.components.feature.awesomebar/index.md) | | +| [mozilla.components.feature.awesomebar.provider](mozilla.components.feature.awesomebar.provider/index.md) | | +| [mozilla.components.feature.contextmenu](mozilla.components.feature.contextmenu/index.md) | | +| [mozilla.components.feature.customtabs](mozilla.components.feature.customtabs/index.md) | | +| [mozilla.components.feature.downloads](mozilla.components.feature.downloads/index.md) | | +| [mozilla.components.feature.findinpage](mozilla.components.feature.findinpage/index.md) | | +| [mozilla.components.feature.findinpage.view](mozilla.components.feature.findinpage.view/index.md) | | +| [mozilla.components.feature.intent](mozilla.components.feature.intent/index.md) | | +| [mozilla.components.feature.prompts](mozilla.components.feature.prompts/index.md) | | +| [mozilla.components.feature.search](mozilla.components.feature.search/index.md) | | +| [mozilla.components.feature.session](mozilla.components.feature.session/index.md) | | +| [mozilla.components.feature.session.bundling](mozilla.components.feature.session.bundling/index.md) | | +| [mozilla.components.feature.sitepermissions](mozilla.components.feature.sitepermissions/index.md) | | +| [mozilla.components.feature.sync](mozilla.components.feature.sync/index.md) | | +| [mozilla.components.feature.tabs](mozilla.components.feature.tabs/index.md) | | +| [mozilla.components.feature.tabs.tabstray](mozilla.components.feature.tabs.tabstray/index.md) | | +| [mozilla.components.feature.tabs.toolbar](mozilla.components.feature.tabs.toolbar/index.md) | | +| [mozilla.components.feature.toolbar](mozilla.components.feature.toolbar/index.md) | | +| [mozilla.components.lib.crash](mozilla.components.lib.crash/index.md) | | +| [mozilla.components.lib.crash.handler](mozilla.components.lib.crash.handler/index.md) | | +| [mozilla.components.lib.crash.prompt](mozilla.components.lib.crash.prompt/index.md) | | +| [mozilla.components.lib.crash.service](mozilla.components.lib.crash.service/index.md) | | +| [mozilla.components.lib.dataprotect](mozilla.components.lib.dataprotect/index.md) | | +| [mozilla.components.lib.fetch.httpurlconnection](mozilla.components.lib.fetch.httpurlconnection/index.md) | | +| [mozilla.components.lib.fetch.okhttp](mozilla.components.lib.fetch.okhttp/index.md) | | +| [mozilla.components.lib.jexl](mozilla.components.lib.jexl/index.md) | | +| [mozilla.components.lib.jexl.ast](mozilla.components.lib.jexl.ast/index.md) | | +| [mozilla.components.lib.jexl.evaluator](mozilla.components.lib.jexl.evaluator/index.md) | | +| [mozilla.components.lib.jexl.ext](mozilla.components.lib.jexl.ext/index.md) | | +| [mozilla.components.lib.jexl.grammar](mozilla.components.lib.jexl.grammar/index.md) | | +| [mozilla.components.lib.jexl.lexer](mozilla.components.lib.jexl.lexer/index.md) | | +| [mozilla.components.lib.jexl.parser](mozilla.components.lib.jexl.parser/index.md) | | +| [mozilla.components.lib.jexl.value](mozilla.components.lib.jexl.value/index.md) | | +| [mozilla.components.lib.publicsuffixlist](mozilla.components.lib.publicsuffixlist/index.md) | | +| [mozilla.components.service.fretboard](mozilla.components.service.fretboard/index.md) | | +| [mozilla.components.service.fretboard.scheduler.jobscheduler](mozilla.components.service.fretboard.scheduler.jobscheduler/index.md) | | +| [mozilla.components.service.fretboard.scheduler.workmanager](mozilla.components.service.fretboard.scheduler.workmanager/index.md) | | +| [mozilla.components.service.fretboard.source.kinto](mozilla.components.service.fretboard.source.kinto/index.md) | | +| [mozilla.components.service.fretboard.storage.flatfile](mozilla.components.service.fretboard.storage.flatfile/index.md) | | +| [mozilla.components.service.fxa](mozilla.components.service.fxa/index.md) | | +| [mozilla.components.service.glean](mozilla.components.service.glean/index.md) | | +| [mozilla.components.service.glean.config](mozilla.components.service.glean.config/index.md) | | +| [mozilla.components.service.glean.storages](mozilla.components.service.glean.storages/index.md) | | +| [mozilla.components.service.sync.logins](mozilla.components.service.sync.logins/index.md) | | +| [mozilla.components.support.base.android](mozilla.components.support.base.android/index.md) | | +| [mozilla.components.support.base.facts](mozilla.components.support.base.facts/index.md) | | +| [mozilla.components.support.base.facts.processor](mozilla.components.support.base.facts.processor/index.md) | | +| [mozilla.components.support.base.feature](mozilla.components.support.base.feature/index.md) | | +| [mozilla.components.support.base.log](mozilla.components.support.base.log/index.md) | | +| [mozilla.components.support.base.log.logger](mozilla.components.support.base.log.logger/index.md) | | +| [mozilla.components.support.base.log.sink](mozilla.components.support.base.log.sink/index.md) | | +| [mozilla.components.support.base.observer](mozilla.components.support.base.observer/index.md) | | +| [mozilla.components.support.ktx.android.arch.lifecycle](mozilla.components.support.ktx.android.arch.lifecycle/index.md) | | +| [mozilla.components.support.ktx.android.content](mozilla.components.support.ktx.android.content/index.md) | | +| [mozilla.components.support.ktx.android.content.res](mozilla.components.support.ktx.android.content.res/index.md) | | +| [mozilla.components.support.ktx.android.graphics](mozilla.components.support.ktx.android.graphics/index.md) | | +| [mozilla.components.support.ktx.android.graphics.drawable](mozilla.components.support.ktx.android.graphics.drawable/index.md) | | +| [mozilla.components.support.ktx.android.org.json](mozilla.components.support.ktx.android.org.json/index.md) | | +| [mozilla.components.support.ktx.android.os](mozilla.components.support.ktx.android.os/index.md) | | +| [mozilla.components.support.ktx.android.util](mozilla.components.support.ktx.android.util/index.md) | | +| [mozilla.components.support.ktx.android.view](mozilla.components.support.ktx.android.view/index.md) | | +| [mozilla.components.support.ktx.kotlin](mozilla.components.support.ktx.kotlin/index.md) | | +| [mozilla.components.support.rustlog](mozilla.components.support.rustlog/index.md) | | +| [mozilla.components.support.test](mozilla.components.support.test/index.md) | | +| [mozilla.components.support.test.robolectric](mozilla.components.support.test.robolectric/index.md) | | +| [mozilla.components.support.utils](mozilla.components.support.utils/index.md) | | +| [mozilla.components.tooling.fetch.tests](mozilla.components.tooling.fetch.tests/index.md) | | +| [mozilla.components.tooling.lint](mozilla.components.tooling.lint/index.md) | | +| [mozilla.components.ui.autocomplete](mozilla.components.ui.autocomplete/index.md) | | +| [mozilla.components.ui.doorhanger](mozilla.components.ui.doorhanger/index.md) | | +| [mozilla.components.ui.progress](mozilla.components.ui.progress/index.md) | | +| [mozilla.components.ui.tabcounter](mozilla.components.ui.tabcounter/index.md) | | +| [org.mozilla.telemetry](org.mozilla.telemetry/index.md) | | +| [org.mozilla.telemetry.config](org.mozilla.telemetry.config/index.md) | | +| [org.mozilla.telemetry.event](org.mozilla.telemetry.event/index.md) | | +| [org.mozilla.telemetry.measurement](org.mozilla.telemetry.measurement/index.md) | | +| [org.mozilla.telemetry.net](org.mozilla.telemetry.net/index.md) | | +| [org.mozilla.telemetry.ping](org.mozilla.telemetry.ping/index.md) | | +| [org.mozilla.telemetry.schedule](org.mozilla.telemetry.schedule/index.md) | | +| [org.mozilla.telemetry.schedule.jobscheduler](org.mozilla.telemetry.schedule.jobscheduler/index.md) | | +| [org.mozilla.telemetry.serialize](org.mozilla.telemetry.serialize/index.md) | | +| [org.mozilla.telemetry.storage](org.mozilla.telemetry.storage/index.md) | | +| [org.mozilla.telemetry.util](org.mozilla.telemetry.util/index.md) | | + +### Index + +[All Types](alltypes/index.md) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/-init-.md b/docs/api/mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/-init-.md new file mode 100644 index 00000000000..2804eba5e2b --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar.layout](../index.md) / [DefaultSuggestionLayout](index.md) / [<init>](./-init-.md) + +# <init> + +`DefaultSuggestionLayout()` + +Default implementation of [SuggestionLayout](../-suggestion-layout/index.md) to be used by [BrowserAwesomeBar](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md). + diff --git a/docs/api/mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/create-view-holder.md b/docs/api/mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/create-view-holder.md new file mode 100644 index 00000000000..728e344ace6 --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/create-view-holder.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar.layout](../index.md) / [DefaultSuggestionLayout](index.md) / [createViewHolder](./create-view-holder.md) + +# createViewHolder + +`fun createViewHolder(awesomeBar: `[`BrowserAwesomeBar`](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`, @LayoutRes layoutId: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`SuggestionViewHolder`](../-suggestion-view-holder/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/layout/DefaultSuggestionLayout.kt#L24) + +Overrides [SuggestionLayout.createViewHolder](../-suggestion-layout/create-view-holder.md) + +Creates and returns a [SuggestionViewHolder](../-suggestion-view-holder/index.md) instance for the provided [View](https://developer.android.com/reference/android/view/View.html). The [BrowserAwesomeBar](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md) will call +[SuggestionViewHolder.bind](../-suggestion-view-holder/bind.md) once this view holder should display the data of a specific [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md). + diff --git a/docs/api/mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/get-layout-resource.md b/docs/api/mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/get-layout-resource.md new file mode 100644 index 00000000000..c8d543fb18d --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/get-layout-resource.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar.layout](../index.md) / [DefaultSuggestionLayout](index.md) / [getLayoutResource](./get-layout-resource.md) + +# getLayoutResource + +`fun getLayoutResource(suggestion: `[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/layout/DefaultSuggestionLayout.kt#L16) + +Overrides [SuggestionLayout.getLayoutResource](../-suggestion-layout/get-layout-resource.md) + +Returns a layout resource ID to be used for this suggestion. The [BrowserAwesomeBar](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md) implementation will take +care of inflating the layout or re-using instances as needed. + diff --git a/docs/api/mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/index.md b/docs/api/mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/index.md new file mode 100644 index 00000000000..d2f82a49c54 --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar.layout/-default-suggestion-layout/index.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar.layout](../index.md) / [DefaultSuggestionLayout](./index.md) + +# DefaultSuggestionLayout + +`class DefaultSuggestionLayout : `[`SuggestionLayout`](../-suggestion-layout/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/layout/DefaultSuggestionLayout.kt#L15) + +Default implementation of [SuggestionLayout](../-suggestion-layout/index.md) to be used by [BrowserAwesomeBar](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `DefaultSuggestionLayout()`
Default implementation of [SuggestionLayout](../-suggestion-layout/index.md) to be used by [BrowserAwesomeBar](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md). | + +### Functions + +| Name | Summary | +|---|---| +| [createViewHolder](create-view-holder.md) | `fun createViewHolder(awesomeBar: `[`BrowserAwesomeBar`](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`, layoutId: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`SuggestionViewHolder`](../-suggestion-view-holder/index.md)
Creates and returns a [SuggestionViewHolder](../-suggestion-view-holder/index.md) instance for the provided [View](https://developer.android.com/reference/android/view/View.html). The [BrowserAwesomeBar](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md) will call [SuggestionViewHolder.bind](../-suggestion-view-holder/bind.md) once this view holder should display the data of a specific [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md). | +| [getLayoutResource](get-layout-resource.md) | `fun getLayoutResource(suggestion: `[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns a layout resource ID to be used for this suggestion. The [BrowserAwesomeBar](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md) implementation will take care of inflating the layout or re-using instances as needed. | diff --git a/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-layout/create-view-holder.md b/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-layout/create-view-holder.md new file mode 100644 index 00000000000..4eeaf1cb065 --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-layout/create-view-holder.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar.layout](../index.md) / [SuggestionLayout](index.md) / [createViewHolder](./create-view-holder.md) + +# createViewHolder + +`abstract fun createViewHolder(awesomeBar: `[`BrowserAwesomeBar`](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`, @LayoutRes layoutId: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`SuggestionViewHolder`](../-suggestion-view-holder/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/layout/SuggestionLayout.kt#L29) + +Creates and returns a [SuggestionViewHolder](../-suggestion-view-holder/index.md) instance for the provided [View](https://developer.android.com/reference/android/view/View.html). The [BrowserAwesomeBar](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md) will call +[SuggestionViewHolder.bind](../-suggestion-view-holder/bind.md) once this view holder should display the data of a specific [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md). + diff --git a/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-layout/get-layout-resource.md b/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-layout/get-layout-resource.md new file mode 100644 index 00000000000..c58f6f551bb --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-layout/get-layout-resource.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar.layout](../index.md) / [SuggestionLayout](index.md) / [getLayoutResource](./get-layout-resource.md) + +# getLayoutResource + +`@LayoutRes abstract fun getLayoutResource(suggestion: `[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/layout/SuggestionLayout.kt#L23) + +Returns a layout resource ID to be used for this suggestion. The [BrowserAwesomeBar](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md) implementation will take +care of inflating the layout or re-using instances as needed. + diff --git a/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-layout/index.md b/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-layout/index.md new file mode 100644 index 00000000000..b5f4d216717 --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-layout/index.md @@ -0,0 +1,22 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar.layout](../index.md) / [SuggestionLayout](./index.md) + +# SuggestionLayout + +`interface SuggestionLayout` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/layout/SuggestionLayout.kt#L17) + +A [SuggestionLayout](./index.md) implementation defines how the suggestions of the [BrowserAwesomeBar](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md) are getting layout. By +default [BrowserAwesomeBar](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md) uses [DefaultSuggestionLayout](../-default-suggestion-layout/index.md). However a consumer can provide its own implementation +in order to create a customized look & feel. + +### Functions + +| Name | Summary | +|---|---| +| [createViewHolder](create-view-holder.md) | `abstract fun createViewHolder(awesomeBar: `[`BrowserAwesomeBar`](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`, layoutId: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`SuggestionViewHolder`](../-suggestion-view-holder/index.md)
Creates and returns a [SuggestionViewHolder](../-suggestion-view-holder/index.md) instance for the provided [View](https://developer.android.com/reference/android/view/View.html). The [BrowserAwesomeBar](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md) will call [SuggestionViewHolder.bind](../-suggestion-view-holder/bind.md) once this view holder should display the data of a specific [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md). | +| [getLayoutResource](get-layout-resource.md) | `abstract fun getLayoutResource(suggestion: `[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns a layout resource ID to be used for this suggestion. The [BrowserAwesomeBar](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md) implementation will take care of inflating the layout or re-using instances as needed. | + +### Inheritors + +| Name | Summary | +|---|---| +| [DefaultSuggestionLayout](../-default-suggestion-layout/index.md) | `class DefaultSuggestionLayout : `[`SuggestionLayout`](./index.md)
Default implementation of [SuggestionLayout](./index.md) to be used by [BrowserAwesomeBar](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md). | diff --git a/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-view-holder/-init-.md b/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-view-holder/-init-.md new file mode 100644 index 00000000000..a3b3aaa0fff --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-view-holder/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar.layout](../index.md) / [SuggestionViewHolder](index.md) / [<init>](./-init-.md) + +# <init> + +`SuggestionViewHolder(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`)` + +A view holder implementation for displaying an [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md). + diff --git a/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-view-holder/bind.md b/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-view-holder/bind.md new file mode 100644 index 00000000000..7ab25827f00 --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-view-holder/bind.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar.layout](../index.md) / [SuggestionViewHolder](index.md) / [bind](./bind.md) + +# bind + +`abstract fun bind(suggestion: `[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`, selectionListener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/layout/SuggestionViewHolder.kt#L19) + +Binds the views in the holder to the [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md). + +Contract: When a suggestion was selected/clicked the view will invoke the appropriate callback of the suggestion +([AwesomeBar.Suggestion.onSuggestionClicked](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/on-suggestion-clicked.md) or [AwesomeBar.Suggestion.onChipClicked](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/on-chip-clicked.md)) as well as the provided +[selectionListener](bind.md#mozilla.components.browser.awesomebar.layout.SuggestionViewHolder$bind(mozilla.components.concept.awesomebar.AwesomeBar.Suggestion, kotlin.Function0((kotlin.Unit)))/selectionListener) function. + diff --git a/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-view-holder/index.md b/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-view-holder/index.md new file mode 100644 index 00000000000..21a2e36436a --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-view-holder/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar.layout](../index.md) / [SuggestionViewHolder](./index.md) + +# SuggestionViewHolder + +`abstract class SuggestionViewHolder` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/layout/SuggestionViewHolder.kt#L9) + +A view holder implementation for displaying an [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SuggestionViewHolder(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`)`
A view holder implementation for displaying an [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md). | + +### Properties + +| Name | Summary | +|---|---| +| [view](view.md) | `val view: `[`View`](https://developer.android.com/reference/android/view/View.html) | + +### Functions + +| Name | Summary | +|---|---| +| [bind](bind.md) | `abstract fun bind(suggestion: `[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`, selectionListener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Binds the views in the holder to the [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md). | diff --git a/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-view-holder/view.md b/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-view-holder/view.md new file mode 100644 index 00000000000..1a946f6ed60 --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar.layout/-suggestion-view-holder/view.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar.layout](../index.md) / [SuggestionViewHolder](index.md) / [view](./view.md) + +# view + +`protected val view: `[`View`](https://developer.android.com/reference/android/view/View.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/layout/SuggestionViewHolder.kt#L10) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.awesomebar.layout/index.md b/docs/api/mozilla.components.browser.awesomebar.layout/index.md new file mode 100644 index 00000000000..c89b6d6d26a --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar.layout/index.md @@ -0,0 +1,11 @@ +[android-components](../index.md) / [mozilla.components.browser.awesomebar.layout](./index.md) + +## Package mozilla.components.browser.awesomebar.layout + +### Types + +| Name | Summary | +|---|---| +| [DefaultSuggestionLayout](-default-suggestion-layout/index.md) | `class DefaultSuggestionLayout : `[`SuggestionLayout`](-suggestion-layout/index.md)
Default implementation of [SuggestionLayout](-suggestion-layout/index.md) to be used by [BrowserAwesomeBar](../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md). | +| [SuggestionLayout](-suggestion-layout/index.md) | `interface SuggestionLayout`
A [SuggestionLayout](-suggestion-layout/index.md) implementation defines how the suggestions of the [BrowserAwesomeBar](../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md) are getting layout. By default [BrowserAwesomeBar](../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md) uses [DefaultSuggestionLayout](-default-suggestion-layout/index.md). However a consumer can provide its own implementation in order to create a customized look & feel. | +| [SuggestionViewHolder](-suggestion-view-holder/index.md) | `abstract class SuggestionViewHolder`
A view holder implementation for displaying an [AwesomeBar.Suggestion](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md). | diff --git a/docs/api/mozilla.components.browser.awesomebar.transform/-suggestion-transformer/index.md b/docs/api/mozilla.components.browser.awesomebar.transform/-suggestion-transformer/index.md new file mode 100644 index 00000000000..0d377ef1a2d --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar.transform/-suggestion-transformer/index.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar.transform](../index.md) / [SuggestionTransformer](./index.md) + +# SuggestionTransformer + +`interface SuggestionTransformer` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/transform/SuggestionTransformer.kt#L15) + +A [SuggestionTransformer](./index.md) takes an input list of [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md) and returns a new list of transformed +[AwesomeBar.Suggestion| objects. + +A [SuggestionTransformer](./index.md) can be used to adding data, removing data or filtering suggestions: + +### Functions + +| Name | Summary | +|---|---| +| [transform](transform.md) | `abstract fun transform(provider: `[`SuggestionProvider`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md)`, suggestions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`>): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`>`
Takes a list of [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md) object and the [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) instance that emitted the suggestions in order to return a transformed list of [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md) objects. | diff --git a/docs/api/mozilla.components.browser.awesomebar.transform/-suggestion-transformer/transform.md b/docs/api/mozilla.components.browser.awesomebar.transform/-suggestion-transformer/transform.md new file mode 100644 index 00000000000..2f0206160e1 --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar.transform/-suggestion-transformer/transform.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar.transform](../index.md) / [SuggestionTransformer](index.md) / [transform](./transform.md) + +# transform + +`abstract fun transform(provider: `[`SuggestionProvider`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md)`, suggestions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`>): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/transform/SuggestionTransformer.kt#L20) + +Takes a list of [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md) object and the [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) instance that emitted the +suggestions in order to return a transformed list of [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md) objects. + diff --git a/docs/api/mozilla.components.browser.awesomebar.transform/index.md b/docs/api/mozilla.components.browser.awesomebar.transform/index.md new file mode 100644 index 00000000000..2dd8a2fb12d --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar.transform/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.browser.awesomebar.transform](./index.md) + +## Package mozilla.components.browser.awesomebar.transform + +### Types + +| Name | Summary | +|---|---| +| [SuggestionTransformer](-suggestion-transformer/index.md) | `interface SuggestionTransformer`
A [SuggestionTransformer](-suggestion-transformer/index.md) takes an input list of [AwesomeBar.Suggestion](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md) and returns a new list of transformed [AwesomeBar.Suggestion| objects. | diff --git a/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/-init-.md b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/-init-.md new file mode 100644 index 00000000000..f2633660f03 --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar](../index.md) / [BrowserAwesomeBar](index.md) / [<init>](./-init-.md) + +# <init> + +`BrowserAwesomeBar(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)` + +A customizable [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation. + diff --git a/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/add-providers.md b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/add-providers.md new file mode 100644 index 00000000000..543b2dc1328 --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/add-providers.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar](../index.md) / [BrowserAwesomeBar](index.md) / [addProviders](./add-providers.md) + +# addProviders + +`@Synchronized fun addProviders(vararg providers: `[`SuggestionProvider`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/BrowserAwesomeBar.kt#L77) + +Overrides [AwesomeBar.addProviders](../../mozilla.components.concept.awesomebar/-awesome-bar/add-providers.md) + +Adds the following [SuggestionProvider](#) instances to be queried for [Suggestion](#)s whenever the text changes. + diff --git a/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md new file mode 100644 index 00000000000..8ad2c6fe48d --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md @@ -0,0 +1,56 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar](../index.md) / [BrowserAwesomeBar](./index.md) + +# BrowserAwesomeBar + +`class BrowserAwesomeBar : RecyclerView, `[`AwesomeBar`](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/BrowserAwesomeBar.kt#L34) + +A customizable [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `BrowserAwesomeBar(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)`
A customizable [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation. | + +### Properties + +| Name | Summary | +|---|---| +| [layout](layout.md) | `var layout: `[`SuggestionLayout`](../../mozilla.components.browser.awesomebar.layout/-suggestion-layout/index.md)
The [SuggestionLayout](../../mozilla.components.browser.awesomebar.layout/-suggestion-layout/index.md) implementation controls layout inflation and view binding for suggestions. | +| [transformer](transformer.md) | `var transformer: `[`SuggestionTransformer`](../../mozilla.components.browser.awesomebar.transform/-suggestion-transformer/index.md)`?`
An optional [SuggestionTransformer](../../mozilla.components.browser.awesomebar.transform/-suggestion-transformer/index.md) that receives [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md) objects from a [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) and returns a new list of transformed [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md) objects. | + +### Functions + +| Name | Summary | +|---|---| +| [addProviders](add-providers.md) | `fun addProviders(vararg providers: `[`SuggestionProvider`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Adds the following [SuggestionProvider](#) instances to be queried for [Suggestion](#)s whenever the text changes. | +| [onDetachedFromWindow](on-detached-from-window.md) | `fun onDetachedFromWindow(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onInputCancelled](on-input-cancelled.md) | `fun onInputCancelled(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Fired when the user has cancelled their interaction with the awesome bar. | +| [onInputChanged](on-input-changed.md) | `fun onInputChanged(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)
Fired whenever the user changes their input, after they have started interacting with the awesome bar. | +| [onInputStarted](on-input-started.md) | `fun onInputStarted(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Fired when the user starts interacting with the awesome bar by entering text in the toolbar. | +| [setOnStopListener](set-on-stop-listener.md) | `fun setOnStopListener(listener: () -> `[`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 lambda to be invoked when the user has finished interacting with the awesome bar (e.g. selected a suggestion). | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [asView](../../mozilla.components.concept.awesomebar/-awesome-bar/as-view.md) | `open fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html)
Casts this awesome bar to an Android View object. | + +### Extension Properties + +| Name | Summary | +|---|---| +| [isLTR](../../mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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? | + +### Extension Functions + +| Name | Summary | +|---|---| +| [forEach](../../mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md) | `fun `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`.forEach(action: (`[`View`](https://developer.android.com/reference/android/view/View.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 the given action on each View in this ViewGroup. | +| [hideKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.hideKeyboard(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Hides the soft input window. | +| [isGone](../../mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [isVisible](../../mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [setPadding](../../mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.setPadding(padding: `[`Padding`](../../mozilla.components.support.base.android/-padding/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Set a padding using [Padding](../../mozilla.components.support.base.android/-padding/index.md) object. | +| [showKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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/mozilla.components.browser.awesomebar/-browser-awesome-bar/layout.md b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/layout.md new file mode 100644 index 00000000000..0f718d58124 --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/layout.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar](../index.md) / [BrowserAwesomeBar](index.md) / [layout](./layout.md) + +# layout + +`var layout: `[`SuggestionLayout`](../../mozilla.components.browser.awesomebar.layout/-suggestion-layout/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/BrowserAwesomeBar.kt#L50) + +The [SuggestionLayout](../../mozilla.components.browser.awesomebar.layout/-suggestion-layout/index.md) implementation controls layout inflation and view binding for suggestions. + diff --git a/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/on-detached-from-window.md b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/on-detached-from-window.md new file mode 100644 index 00000000000..92ded12cbfe --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/on-detached-from-window.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar](../index.md) / [BrowserAwesomeBar](index.md) / [onDetachedFromWindow](./on-detached-from-window.md) + +# onDetachedFromWindow + +`protected fun onDetachedFromWindow(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/BrowserAwesomeBar.kt#L108) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/on-input-cancelled.md b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/on-input-cancelled.md new file mode 100644 index 00000000000..b984f8a6400 --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/on-input-cancelled.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar](../index.md) / [BrowserAwesomeBar](index.md) / [onInputCancelled](./on-input-cancelled.md) + +# onInputCancelled + +`@Synchronized fun onInputCancelled(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/BrowserAwesomeBar.kt#L116) + +Overrides [AwesomeBar.onInputCancelled](../../mozilla.components.concept.awesomebar/-awesome-bar/on-input-cancelled.md) + +Fired when the user has cancelled their interaction with the awesome bar. + diff --git a/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/on-input-changed.md b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/on-input-changed.md new file mode 100644 index 00000000000..bcdddf172a7 --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/on-input-changed.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar](../index.md) / [BrowserAwesomeBar](index.md) / [onInputChanged](./on-input-changed.md) + +# onInputChanged + +`@Synchronized fun onInputChanged(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/BrowserAwesomeBar.kt#L87) + +Overrides [AwesomeBar.onInputChanged](../../mozilla.components.concept.awesomebar/-awesome-bar/on-input-changed.md) + +Fired whenever the user changes their input, after they have started interacting with the awesome bar. + +### Parameters + +`text` - The current user input in the toolbar. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/on-input-started.md b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/on-input-started.md new file mode 100644 index 00000000000..313b67c9a56 --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/on-input-started.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar](../index.md) / [BrowserAwesomeBar](index.md) / [onInputStarted](./on-input-started.md) + +# onInputStarted + +`@Synchronized fun onInputStarted(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/BrowserAwesomeBar.kt#L82) + +Overrides [AwesomeBar.onInputStarted](../../mozilla.components.concept.awesomebar/-awesome-bar/on-input-started.md) + +Fired when the user starts interacting with the awesome bar by entering text in the toolbar. + diff --git a/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/set-on-stop-listener.md b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/set-on-stop-listener.md new file mode 100644 index 00000000000..82f89c31618 --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/set-on-stop-listener.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar](../index.md) / [BrowserAwesomeBar](index.md) / [setOnStopListener](./set-on-stop-listener.md) + +# setOnStopListener + +`fun setOnStopListener(listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/BrowserAwesomeBar.kt#L122) + +Overrides [AwesomeBar.setOnStopListener](../../mozilla.components.concept.awesomebar/-awesome-bar/set-on-stop-listener.md) + +Adds a lambda to be invoked when the user has finished interacting with the awesome bar (e.g. selected a +suggestion). + diff --git a/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/transformer.md b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/transformer.md new file mode 100644 index 00000000000..5ed0743bf80 --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar/-browser-awesome-bar/transformer.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.awesomebar](../index.md) / [BrowserAwesomeBar](index.md) / [transformer](./transformer.md) + +# transformer + +`var transformer: `[`SuggestionTransformer`](../../mozilla.components.browser.awesomebar.transform/-suggestion-transformer/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/awesomebar/src/main/java/mozilla/components/browser/awesomebar/BrowserAwesomeBar.kt#L58) + +An optional [SuggestionTransformer](../../mozilla.components.browser.awesomebar.transform/-suggestion-transformer/index.md) that receives [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md) objects from a +[AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) and returns a new list of transformed [AwesomeBar.Suggestion](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md) objects. + diff --git a/docs/api/mozilla.components.browser.awesomebar/index.md b/docs/api/mozilla.components.browser.awesomebar/index.md new file mode 100644 index 00000000000..ed9debe8d8e --- /dev/null +++ b/docs/api/mozilla.components.browser.awesomebar/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.browser.awesomebar](./index.md) + +## Package mozilla.components.browser.awesomebar + +### Types + +| Name | Summary | +|---|---| +| [BrowserAwesomeBar](-browser-awesome-bar/index.md) | `class BrowserAwesomeBar : RecyclerView, `[`AwesomeBar`](../mozilla.components.concept.awesomebar/-awesome-bar/index.md)
A customizable [AwesomeBar](../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation. | diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/-init-.md b/docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/-init-.md new file mode 100644 index 00000000000..e7ec2b7e25d --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [BaseDomainAutocompleteProvider](index.md) / [<init>](./-init-.md) + +# <init> + +`BaseDomainAutocompleteProvider(list: `[`DomainList`](../-domain-list/index.md)`)` + +Provides common autocomplete functionality powered by domain lists. + diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/domains.md b/docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/domains.md new file mode 100644 index 00000000000..b8a0ddcacb4 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/domains.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [BaseDomainAutocompleteProvider](index.md) / [domains](./domains.md) + +# domains + +`@Volatile var domains: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Domain`](../../mozilla.components.browser.domains/-domain/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L57) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/get-autocomplete-suggestion.md b/docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/get-autocomplete-suggestion.md new file mode 100644 index 00000000000..18b92bfbd5c --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/get-autocomplete-suggestion.md @@ -0,0 +1,18 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [BaseDomainAutocompleteProvider](index.md) / [getAutocompleteSuggestion](./get-autocomplete-suggestion.md) + +# getAutocompleteSuggestion + +`open fun getAutocompleteSuggestion(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`DomainAutocompleteResult`](../-domain-autocomplete-result/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L68) + +Overrides [DomainAutocompleteProvider.getAutocompleteSuggestion](../-domain-autocomplete-provider/get-autocomplete-suggestion.md) + +Computes an autocomplete suggestion for the given text, and invokes the +provided callback, passing the result. + +### Parameters + +`query` - text to be auto completed + +**Return** +the result of auto-completion, or null if no match is found. + diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/index.md b/docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/index.md new file mode 100644 index 00000000000..fb26f0e3a7b --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/index.md @@ -0,0 +1,33 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [BaseDomainAutocompleteProvider](./index.md) + +# BaseDomainAutocompleteProvider + +`abstract class BaseDomainAutocompleteProvider : `[`DomainAutocompleteProvider`](../-domain-autocomplete-provider/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L52) + +Provides common autocomplete functionality powered by domain lists. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `BaseDomainAutocompleteProvider(list: `[`DomainList`](../-domain-list/index.md)`)`
Provides common autocomplete functionality powered by domain lists. | + +### Properties + +| Name | Summary | +|---|---| +| [domains](domains.md) | `var domains: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Domain`](../../mozilla.components.browser.domains/-domain/index.md)`>` | + +### Functions + +| Name | Summary | +|---|---| +| [getAutocompleteSuggestion](get-autocomplete-suggestion.md) | `open fun getAutocompleteSuggestion(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`DomainAutocompleteResult`](../-domain-autocomplete-result/index.md)`?`
Computes an autocomplete suggestion for the given text, and invokes the provided callback, passing the result. | +| [initialize](initialize.md) | `abstract fun initialize(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [CustomDomainsProvider](../-custom-domains-provider/index.md) | `class CustomDomainsProvider : `[`BaseDomainAutocompleteProvider`](./index.md)
Provides autocomplete functionality for domains based on a list managed by [CustomDomains](../../mozilla.components.browser.domains/-custom-domains/index.md). | +| [ShippedDomainsProvider](../-shipped-domains-provider/index.md) | `class ShippedDomainsProvider : `[`BaseDomainAutocompleteProvider`](./index.md)
Provides autocomplete functionality for domains based on provided list of assets (see [Domains](../../mozilla.components.browser.domains/-domains/index.md)). | diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/initialize.md b/docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/initialize.md new file mode 100644 index 00000000000..2d859fb24c2 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-base-domain-autocomplete-provider/initialize.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [BaseDomainAutocompleteProvider](index.md) / [initialize](./initialize.md) + +# initialize + +`abstract fun initialize(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L59) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-custom-domains-provider/-init-.md b/docs/api/mozilla.components.browser.domains.autocomplete/-custom-domains-provider/-init-.md new file mode 100644 index 00000000000..2a653d44075 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-custom-domains-provider/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [CustomDomainsProvider](index.md) / [<init>](./-init-.md) + +# <init> + +`CustomDomainsProvider()` + +Provides autocomplete functionality for domains based on a list managed by [CustomDomains](../../mozilla.components.browser.domains/-custom-domains/index.md). + diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-custom-domains-provider/index.md b/docs/api/mozilla.components.browser.domains.autocomplete/-custom-domains-provider/index.md new file mode 100644 index 00000000000..662c792dd65 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-custom-domains-provider/index.md @@ -0,0 +1,31 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [CustomDomainsProvider](./index.md) + +# CustomDomainsProvider + +`class CustomDomainsProvider : `[`BaseDomainAutocompleteProvider`](../-base-domain-autocomplete-provider/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L37) + +Provides autocomplete functionality for domains based on a list managed by [CustomDomains](../../mozilla.components.browser.domains/-custom-domains/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `CustomDomainsProvider()`
Provides autocomplete functionality for domains based on a list managed by [CustomDomains](../../mozilla.components.browser.domains/-custom-domains/index.md). | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [domains](../-base-domain-autocomplete-provider/domains.md) | `var domains: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Domain`](../../mozilla.components.browser.domains/-domain/index.md)`>` | + +### Functions + +| Name | Summary | +|---|---| +| [initialize](initialize.md) | `fun initialize(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getAutocompleteSuggestion](../-base-domain-autocomplete-provider/get-autocomplete-suggestion.md) | `open fun getAutocompleteSuggestion(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`DomainAutocompleteResult`](../-domain-autocomplete-result/index.md)`?`
Computes an autocomplete suggestion for the given text, and invokes the provided callback, passing the result. | diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-custom-domains-provider/initialize.md b/docs/api/mozilla.components.browser.domains.autocomplete/-custom-domains-provider/initialize.md new file mode 100644 index 00000000000..a2ddb68f30b --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-custom-domains-provider/initialize.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [CustomDomainsProvider](index.md) / [initialize](./initialize.md) + +# initialize + +`fun initialize(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L38) + +Overrides [BaseDomainAutocompleteProvider.initialize](../-base-domain-autocomplete-provider/initialize.md) + diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-provider/get-autocomplete-suggestion.md b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-provider/get-autocomplete-suggestion.md new file mode 100644 index 00000000000..1fabee3b691 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-provider/get-autocomplete-suggestion.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [DomainAutocompleteProvider](index.md) / [getAutocompleteSuggestion](./get-autocomplete-suggestion.md) + +# getAutocompleteSuggestion + +`abstract fun getAutocompleteSuggestion(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`DomainAutocompleteResult`](../-domain-autocomplete-result/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L46) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-provider/index.md b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-provider/index.md new file mode 100644 index 00000000000..858c786bf38 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-provider/index.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [DomainAutocompleteProvider](./index.md) + +# DomainAutocompleteProvider + +`interface DomainAutocompleteProvider` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L45) + +### Functions + +| Name | Summary | +|---|---| +| [getAutocompleteSuggestion](get-autocomplete-suggestion.md) | `abstract fun getAutocompleteSuggestion(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`DomainAutocompleteResult`](../-domain-autocomplete-result/index.md)`?` | + +### Inheritors + +| Name | Summary | +|---|---| +| [BaseDomainAutocompleteProvider](../-base-domain-autocomplete-provider/index.md) | `abstract class BaseDomainAutocompleteProvider : `[`DomainAutocompleteProvider`](./index.md)
Provides common autocomplete functionality powered by domain lists. | diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/-init-.md b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/-init-.md new file mode 100644 index 00000000000..4f8dc5fa599 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [DomainAutocompleteResult](index.md) / [<init>](./-init-.md) + +# <init> + +`DomainAutocompleteResult(input: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, 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)`, totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` + +Describes an autocompletion result against a list of domains. + diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/index.md b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/index.md new file mode 100644 index 00000000000..72597d7e633 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [DomainAutocompleteResult](./index.md) + +# DomainAutocompleteResult + +`class DomainAutocompleteResult` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L117) + +Describes an autocompletion result against a list of domains. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `DomainAutocompleteResult(input: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, 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)`, totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)`
Describes an autocompletion result against a list of domains. | + +### Properties + +| Name | Summary | +|---|---| +| [input](input.md) | `val input: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Input for which this result is being provided. | +| [source](source.md) | `val source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Name of the autocompletion source. | +| [text](text.md) | `val text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Result of autocompletion, text to be displayed. | +| [totalItems](total-items.md) | `val totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
A total number of results also available. | +| [url](url.md) | `val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Result of autocompletion, full matching url. | diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/input.md b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/input.md new file mode 100644 index 00000000000..a3e59ca0f6e --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/input.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [DomainAutocompleteResult](index.md) / [input](./input.md) + +# input + +`val input: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L118) + +Input for which this result is being provided. + +### Property + +`input` - Input for which this result is being provided. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/source.md b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/source.md new file mode 100644 index 00000000000..61ad75cf8ae --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/source.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [DomainAutocompleteResult](index.md) / [source](./source.md) + +# source + +`val source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L121) + +Name of the autocompletion source. + +### Property + +`source` - Name of the autocompletion source. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/text.md b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/text.md new file mode 100644 index 00000000000..8558414c535 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/text.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [DomainAutocompleteResult](index.md) / [text](./text.md) + +# text + +`val text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L119) + +Result of autocompletion, text to be displayed. + +### Property + +`text` - Result of autocompletion, text to be displayed. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/total-items.md b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/total-items.md new file mode 100644 index 00000000000..3fdf13d4f03 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/total-items.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [DomainAutocompleteResult](index.md) / [totalItems](./total-items.md) + +# totalItems + +`val totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L122) + +A total number of results also available. + +### Property + +`totalItems` - A total number of results also available. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/url.md b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/url.md new file mode 100644 index 00000000000..bea15b3602f --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-autocomplete-result/url.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [DomainAutocompleteResult](index.md) / [url](./url.md) + +# url + +`val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L120) + +Result of autocompletion, full matching url. + +### Property + +`url` - Result of autocompletion, full matching url. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-domain-list/-c-u-s-t-o-m.md b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-list/-c-u-s-t-o-m.md new file mode 100644 index 00000000000..50f5c780b8d --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-list/-c-u-s-t-o-m.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [DomainList](index.md) / [CUSTOM](./-c-u-s-t-o-m.md) + +# CUSTOM + +`CUSTOM` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L20) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [listName](list-name.md) | `val listName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-domain-list/-d-e-f-a-u-l-t.md b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-list/-d-e-f-a-u-l-t.md new file mode 100644 index 00000000000..b60dc6b3a0b --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-list/-d-e-f-a-u-l-t.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [DomainList](index.md) / [DEFAULT](./-d-e-f-a-u-l-t.md) + +# DEFAULT + +`DEFAULT` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L19) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [listName](list-name.md) | `val listName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-domain-list/index.md b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-list/index.md new file mode 100644 index 00000000000..aaa17e48dd5 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-list/index.md @@ -0,0 +1,18 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [DomainList](./index.md) + +# DomainList + +`enum class DomainList` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L18) + +### Enum Values + +| Name | Summary | +|---|---| +| [DEFAULT](-d-e-f-a-u-l-t.md) | | +| [CUSTOM](-c-u-s-t-o-m.md) | | + +### Properties + +| Name | Summary | +|---|---| +| [listName](list-name.md) | `val listName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-domain-list/list-name.md b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-list/list-name.md new file mode 100644 index 00000000000..1eccc3f7ddf --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-domain-list/list-name.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [DomainList](index.md) / [listName](./list-name.md) + +# listName + +`val listName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L18) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-shipped-domains-provider/-init-.md b/docs/api/mozilla.components.browser.domains.autocomplete/-shipped-domains-provider/-init-.md new file mode 100644 index 00000000000..85d89590392 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-shipped-domains-provider/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [ShippedDomainsProvider](index.md) / [<init>](./-init-.md) + +# <init> + +`ShippedDomainsProvider()` + +Provides autocomplete functionality for domains based on provided list of assets (see [Domains](../../mozilla.components.browser.domains/-domains/index.md)). + diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-shipped-domains-provider/index.md b/docs/api/mozilla.components.browser.domains.autocomplete/-shipped-domains-provider/index.md new file mode 100644 index 00000000000..1b771337e4b --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-shipped-domains-provider/index.md @@ -0,0 +1,31 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [ShippedDomainsProvider](./index.md) + +# ShippedDomainsProvider + +`class ShippedDomainsProvider : `[`BaseDomainAutocompleteProvider`](../-base-domain-autocomplete-provider/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L26) + +Provides autocomplete functionality for domains based on provided list of assets (see [Domains](../../mozilla.components.browser.domains/-domains/index.md)). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ShippedDomainsProvider()`
Provides autocomplete functionality for domains based on provided list of assets (see [Domains](../../mozilla.components.browser.domains/-domains/index.md)). | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [domains](../-base-domain-autocomplete-provider/domains.md) | `var domains: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Domain`](../../mozilla.components.browser.domains/-domain/index.md)`>` | + +### Functions + +| Name | Summary | +|---|---| +| [initialize](initialize.md) | `fun initialize(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getAutocompleteSuggestion](../-base-domain-autocomplete-provider/get-autocomplete-suggestion.md) | `open fun getAutocompleteSuggestion(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`DomainAutocompleteResult`](../-domain-autocomplete-result/index.md)`?`
Computes an autocomplete suggestion for the given text, and invokes the provided callback, passing the result. | diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/-shipped-domains-provider/initialize.md b/docs/api/mozilla.components.browser.domains.autocomplete/-shipped-domains-provider/initialize.md new file mode 100644 index 00000000000..1b45806e3b5 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/-shipped-domains-provider/initialize.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains.autocomplete](../index.md) / [ShippedDomainsProvider](index.md) / [initialize](./initialize.md) + +# initialize + +`fun initialize(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/autocomplete/Providers.kt#L27) + +Overrides [BaseDomainAutocompleteProvider.initialize](../-base-domain-autocomplete-provider/initialize.md) + diff --git a/docs/api/mozilla.components.browser.domains.autocomplete/index.md b/docs/api/mozilla.components.browser.domains.autocomplete/index.md new file mode 100644 index 00000000000..747227e81db --- /dev/null +++ b/docs/api/mozilla.components.browser.domains.autocomplete/index.md @@ -0,0 +1,14 @@ +[android-components](../index.md) / [mozilla.components.browser.domains.autocomplete](./index.md) + +## Package mozilla.components.browser.domains.autocomplete + +### Types + +| Name | Summary | +|---|---| +| [BaseDomainAutocompleteProvider](-base-domain-autocomplete-provider/index.md) | `abstract class BaseDomainAutocompleteProvider : `[`DomainAutocompleteProvider`](-domain-autocomplete-provider/index.md)
Provides common autocomplete functionality powered by domain lists. | +| [CustomDomainsProvider](-custom-domains-provider/index.md) | `class CustomDomainsProvider : `[`BaseDomainAutocompleteProvider`](-base-domain-autocomplete-provider/index.md)
Provides autocomplete functionality for domains based on a list managed by [CustomDomains](../mozilla.components.browser.domains/-custom-domains/index.md). | +| [DomainAutocompleteProvider](-domain-autocomplete-provider/index.md) | `interface DomainAutocompleteProvider` | +| [DomainAutocompleteResult](-domain-autocomplete-result/index.md) | `class DomainAutocompleteResult`
Describes an autocompletion result against a list of domains. | +| [DomainList](-domain-list/index.md) | `enum class DomainList` | +| [ShippedDomainsProvider](-shipped-domains-provider/index.md) | `class ShippedDomainsProvider : `[`BaseDomainAutocompleteProvider`](-base-domain-autocomplete-provider/index.md)
Provides autocomplete functionality for domains based on provided list of assets (see [Domains](../mozilla.components.browser.domains/-domains/index.md)). | diff --git a/docs/api/mozilla.components.browser.domains/-custom-domains/add.md b/docs/api/mozilla.components.browser.domains/-custom-domains/add.md new file mode 100644 index 00000000000..cf96a7f0eb3 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-custom-domains/add.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains](../index.md) / [CustomDomains](index.md) / [add](./add.md) + +# add + +`fun add(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/CustomDomains.kt#L48) + +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/mozilla.components.browser.domains/-custom-domains/index.md b/docs/api/mozilla.components.browser.domains/-custom-domains/index.md new file mode 100644 index 00000000000..ab6f0442e5d --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-custom-domains/index.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains](../index.md) / [CustomDomains](./index.md) + +# CustomDomains + +`object CustomDomains` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/CustomDomains.kt#L13) + +Contains functionality to manage custom domains for auto-completion. + +### Functions + +| Name | Summary | +|---|---| +| [add](add.md) | `fun add(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, 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.md) | `fun load(context: `[`Context`](https://developer.android.com/reference/android/content/Context.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)`>`
Loads the previously added/saved custom domains from preferences. | +| [remove](remove.md) | `fun remove(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, 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.md) | `fun save(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, 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/mozilla.components.browser.domains/-custom-domains/load.md b/docs/api/mozilla.components.browser.domains/-custom-domains/load.md new file mode 100644 index 00000000000..90698f156a3 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-custom-domains/load.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains](../index.md) / [CustomDomains](index.md) / [load](./load.md) + +# load + +`fun load(context: `[`Context`](https://developer.android.com/reference/android/content/Context.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)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/CustomDomains.kt#L24) + +Loads the previously added/saved custom domains from preferences. + +### Parameters + +`context` - the application context + +**Return** +list of custom domains + diff --git a/docs/api/mozilla.components.browser.domains/-custom-domains/remove.md b/docs/api/mozilla.components.browser.domains/-custom-domains/remove.md new file mode 100644 index 00000000000..8d2aea4df46 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-custom-domains/remove.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains](../index.md) / [CustomDomains](index.md) / [remove](./remove.md) + +# remove + +`fun remove(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/CustomDomains.kt#L62) + +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/mozilla.components.browser.domains/-custom-domains/save.md b/docs/api/mozilla.components.browser.domains/-custom-domains/save.md new file mode 100644 index 00000000000..b468fced0d1 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-custom-domains/save.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains](../index.md) / [CustomDomains](index.md) / [save](./save.md) + +# save + +`fun save(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/CustomDomains.kt#L35) + +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/mozilla.components.browser.domains/-domain-auto-complete-provider/-autocomplete-source/-c-u-s-t-o-m_-l-i-s-t.md b/docs/api/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..49860a10497 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-autocomplete-source/-c-u-s-t-o-m_-l-i-s-t.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.domains](../../index.md) / [DomainAutoCompleteProvider](../index.md) / [AutocompleteSource](index.md) / [CUSTOM_LIST](./-c-u-s-t-o-m_-l-i-s-t.md) + +# CUSTOM_LIST + +`const val CUSTOM_LIST: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/DomainAutoCompleteProvider.kt#L24) \ No newline at end of file diff --git a/docs/api/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/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..754b2c0c208 --- /dev/null +++ b/docs/api/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,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.domains](../../index.md) / [DomainAutoCompleteProvider](../index.md) / [AutocompleteSource](index.md) / [DEFAULT_LIST](./-d-e-f-a-u-l-t_-l-i-s-t.md) + +# DEFAULT_LIST + +`const val DEFAULT_LIST: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/DomainAutoCompleteProvider.kt#L23) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-autocomplete-source/index.md b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-autocomplete-source/index.md new file mode 100644 index 00000000000..c6138b04e32 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-autocomplete-source/index.md @@ -0,0 +1,12 @@ +[android-components](../../../index.md) / [mozilla.components.browser.domains](../../index.md) / [DomainAutoCompleteProvider](../index.md) / [AutocompleteSource](./index.md) + +# AutocompleteSource + +`object AutocompleteSource` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/DomainAutoCompleteProvider.kt#L22) + +### Properties + +| Name | Summary | +|---|---| +| [CUSTOM_LIST](-c-u-s-t-o-m_-l-i-s-t.md) | `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.md) | `const val DEFAULT_LIST: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-init-.md b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-init-.md new file mode 100644 index 00000000000..52cdff92e80 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-init-.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains](../index.md) / [DomainAutoCompleteProvider](index.md) / [<init>](./-init-.md) + +# <init> + +`DomainAutoCompleteProvider()` + +Provides autocomplete functionality for domains, based on a provided list +of assets (see [Domains](../-domains/index.md)) and/or a custom domain list managed by +[CustomDomains](../-custom-domains/index.md). + diff --git a/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/-init-.md b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/-init-.md new file mode 100644 index 00000000000..6eef5866f6e --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.domains](../../index.md) / [DomainAutoCompleteProvider](../index.md) / [Result](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/index.md b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/index.md new file mode 100644 index 00000000000..a2c2bcbc7a4 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/index.md @@ -0,0 +1,22 @@ +[android-components](../../../index.md) / [mozilla.components.browser.domains](../../index.md) / [DomainAutoCompleteProvider](../index.md) / [Result](./index.md) + +# Result + +`data class Result` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/DomainAutoCompleteProvider.kt#L38) + +Represents a result of auto-completion. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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 + +| Name | Summary | +|---|---| +| [size](size.md) | `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.md) | `val source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
the source identifier of the autocomplete source | +| [text](text.md) | `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.md) followed by the completion text (e.g. moz => mozilla.org) | +| [url](url.md) | `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/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/size.md b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/size.md new file mode 100644 index 00000000000..7bb9e051165 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/size.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.browser.domains](../../index.md) / [DomainAutoCompleteProvider](../index.md) / [Result](index.md) / [size](./size.md) + +# size + +`val size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/DomainAutoCompleteProvider.kt#L38) + +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/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/source.md b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/source.md new file mode 100644 index 00000000000..5f11bd68a8c --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/source.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.browser.domains](../../index.md) / [DomainAutoCompleteProvider](../index.md) / [Result](index.md) / [source](./source.md) + +# source + +`val source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/DomainAutoCompleteProvider.kt#L38) + +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/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/text.md b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/text.md new file mode 100644 index 00000000000..efb344b5e11 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/text.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.browser.domains](../../index.md) / [DomainAutoCompleteProvider](../index.md) / [Result](index.md) / [text](./text.md) + +# text + +`val text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/DomainAutoCompleteProvider.kt#L38) + +the result text starting with the raw search text as passed +to [autocomplete](../autocomplete.md) 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.md) followed by the completion text (e.g. moz => mozilla.org) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/url.md b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/url.md new file mode 100644 index 00000000000..14dcd00a419 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/-result/url.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.browser.domains](../../index.md) / [DomainAutoCompleteProvider](../index.md) / [Result](index.md) / [url](./url.md) + +# url + +`val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/DomainAutoCompleteProvider.kt#L38) + +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/mozilla.components.browser.domains/-domain-auto-complete-provider/autocomplete.md b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/autocomplete.md new file mode 100644 index 00000000000..1539ccf6622 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/autocomplete.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains](../index.md) / [DomainAutoCompleteProvider](index.md) / [autocomplete](./autocomplete.md) + +# autocomplete + +`fun autocomplete(rawText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Result`](-result/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/DomainAutoCompleteProvider.kt#L57) + +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/mozilla.components.browser.domains/-domain-auto-complete-provider/index.md b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/index.md new file mode 100644 index 00000000000..0d6c21c9a24 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/index.md @@ -0,0 +1,30 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains](../index.md) / [DomainAutoCompleteProvider](./index.md) + +# DomainAutoCompleteProvider + +`class ~~DomainAutoCompleteProvider~~` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/DomainAutoCompleteProvider.kt#L21) +**Deprecated:** Use [Providers.ShippedDomainsProvider] or [Providers.CustomDomainsProvider] + +Provides autocomplete functionality for domains, based on a provided list +of assets (see [Domains](../-domains/index.md)) and/or a custom domain list managed by +[CustomDomains](../-custom-domains/index.md). + +### Types + +| Name | Summary | +|---|---| +| [AutocompleteSource](-autocomplete-source/index.md) | `object AutocompleteSource` | +| [Result](-result/index.md) | `data class Result`
Represents a result of auto-completion. | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `DomainAutoCompleteProvider()`
Provides autocomplete functionality for domains, based on a provided list of assets (see [Domains](../-domains/index.md)) and/or a custom domain list managed by [CustomDomains](../-custom-domains/index.md). | + +### Functions + +| Name | Summary | +|---|---| +| [autocomplete](autocomplete.md) | `fun autocomplete(rawText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Result`](-result/index.md)
Computes an autocomplete suggestion for the given text, and invokes the provided callback, passing the result. | +| [initialize](initialize.md) | `fun initialize(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, 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/mozilla.components.browser.domains/-domain-auto-complete-provider/initialize.md b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/initialize.md new file mode 100644 index 00000000000..1aeef7ea1d6 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain-auto-complete-provider/initialize.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains](../index.md) / [DomainAutoCompleteProvider](index.md) / [initialize](./initialize.md) + +# initialize + +`fun initialize(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/DomainAutoCompleteProvider.kt#L87) + +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.md) 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/mozilla.components.browser.domains/-domain/-init-.md b/docs/api/mozilla.components.browser.domains/-domain/-init-.md new file mode 100644 index 00000000000..5373360bff9 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains](../index.md) / [Domain](index.md) / [<init>](./-init-.md) + +# <init> + +`Domain(protocol: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, hasWww: `[`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)`)` + +Class intended for internal use which encapsulates meta data about a domain. + diff --git a/docs/api/mozilla.components.browser.domains/-domain/create.md b/docs/api/mozilla.components.browser.domains/-domain/create.md new file mode 100644 index 00000000000..f84a6ef8be8 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain/create.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains](../index.md) / [Domain](index.md) / [create](./create.md) + +# create + +`fun create(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Domain`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/Domain.kt#L23) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.domains/-domain/has-www.md b/docs/api/mozilla.components.browser.domains/-domain/has-www.md new file mode 100644 index 00000000000..b940ce01b39 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain/has-www.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains](../index.md) / [Domain](index.md) / [hasWww](./has-www.md) + +# hasWww + +`val hasWww: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/Domain.kt#L10) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.domains/-domain/host.md b/docs/api/mozilla.components.browser.domains/-domain/host.md new file mode 100644 index 00000000000..af0e16f7fdb --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain/host.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains](../index.md) / [Domain](index.md) / [host](./host.md) + +# host + +`val host: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/Domain.kt#L10) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.domains/-domain/index.md b/docs/api/mozilla.components.browser.domains/-domain/index.md new file mode 100644 index 00000000000..64b0771acb2 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain/index.md @@ -0,0 +1,27 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains](../index.md) / [Domain](./index.md) + +# Domain + +`data class Domain` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/Domain.kt#L10) + +Class intended for internal use which encapsulates meta data about a domain. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Domain(protocol: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, hasWww: `[`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)`)`
Class intended for internal use which encapsulates meta data about a domain. | + +### Properties + +| Name | Summary | +|---|---| +| [hasWww](has-www.md) | `val hasWww: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [host](host.md) | `val host: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [protocol](protocol.md) | `val protocol: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [create](create.md) | `fun create(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Domain`](./index.md) | diff --git a/docs/api/mozilla.components.browser.domains/-domain/protocol.md b/docs/api/mozilla.components.browser.domains/-domain/protocol.md new file mode 100644 index 00000000000..8e91f5caef9 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domain/protocol.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains](../index.md) / [Domain](index.md) / [protocol](./protocol.md) + +# protocol + +`val protocol: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/Domain.kt#L10) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.domains/-domains/index.md b/docs/api/mozilla.components.browser.domains/-domains/index.md new file mode 100644 index 00000000000..f9c9cc622f5 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domains/index.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains](../index.md) / [Domains](./index.md) + +# Domains + +`object Domains` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/Domains.kt#L17) + +Contains functionality to access domain lists shipped as part of this +module's assets. + +### Functions + +| Name | Summary | +|---|---| +| [load](load.md) | `fun load(context: `[`Context`](https://developer.android.com/reference/android/content/Context.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)`>`
Loads the domains applicable to the app's locale, plus the domains in the 'global' list. | diff --git a/docs/api/mozilla.components.browser.domains/-domains/load.md b/docs/api/mozilla.components.browser.domains/-domains/load.md new file mode 100644 index 00000000000..3655e540ebe --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/-domains/load.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.domains](../index.md) / [Domains](index.md) / [load](./load.md) + +# load + +`fun load(context: `[`Context`](https://developer.android.com/reference/android/content/Context.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)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/domains/src/main/java/mozilla/components/browser/domains/Domains.kt#L26) + +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/mozilla.components.browser.domains/index.md b/docs/api/mozilla.components.browser.domains/index.md new file mode 100644 index 00000000000..5745b0b3aa0 --- /dev/null +++ b/docs/api/mozilla.components.browser.domains/index.md @@ -0,0 +1,12 @@ +[android-components](../index.md) / [mozilla.components.browser.domains](./index.md) + +## Package mozilla.components.browser.domains + +### Types + +| Name | Summary | +|---|---| +| [CustomDomains](-custom-domains/index.md) | `object CustomDomains`
Contains functionality to manage custom domains for auto-completion. | +| [Domain](-domain/index.md) | `data class Domain`
Class intended for internal use which encapsulates meta data about a domain. | +| [DomainAutoCompleteProvider](-domain-auto-complete-provider/index.md) | `class ~~DomainAutoCompleteProvider~~`
Provides autocomplete functionality for domains, based on a provided list of assets (see [Domains](-domains/index.md)) and/or a custom domain list managed by [CustomDomains](-custom-domains/index.md). | +| [Domains](-domains/index.md) | `object Domains`
Contains functionality to access domain lists shipped as part of this module's assets. | diff --git a/docs/api/mozilla.components.browser.engine.gecko.fetch/-byte-buffer-input-stream/-init-.md b/docs/api/mozilla.components.browser.engine.gecko.fetch/-byte-buffer-input-stream/-init-.md new file mode 100644 index 00000000000..6debf25d80f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.fetch/-byte-buffer-input-stream/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko.fetch](../index.md) / [ByteBufferInputStream](index.md) / [<init>](./-init-.md) + +# <init> + +`ByteBufferInputStream(buf: `[`ByteBuffer`](https://developer.android.com/reference/java/nio/ByteBuffer.html)`)` \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko.fetch/-byte-buffer-input-stream/index.md b/docs/api/mozilla.components.browser.engine.gecko.fetch/-byte-buffer-input-stream/index.md new file mode 100644 index 00000000000..29b273937e9 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.fetch/-byte-buffer-input-stream/index.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko.fetch](../index.md) / [ByteBufferInputStream](./index.md) + +# ByteBufferInputStream + +`class ByteBufferInputStream : `[`InputStream`](https://developer.android.com/reference/java/io/InputStream.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-nightly/src/main/java/mozilla/components/browser/engine/gecko/fetch/GeckoViewFetchClient.kt#L111) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ByteBufferInputStream(buf: `[`ByteBuffer`](https://developer.android.com/reference/java/nio/ByteBuffer.html)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [read](read.md) | `fun read(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
`fun read(bytes: `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`, off: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, len: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.engine.gecko.fetch/-byte-buffer-input-stream/read.md b/docs/api/mozilla.components.browser.engine.gecko.fetch/-byte-buffer-input-stream/read.md new file mode 100644 index 00000000000..b2b30e8a9f5 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.fetch/-byte-buffer-input-stream/read.md @@ -0,0 +1,6 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko.fetch](../index.md) / [ByteBufferInputStream](index.md) / [read](./read.md) + +# read + +`fun read(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-nightly/src/main/java/mozilla/components/browser/engine/gecko/fetch/GeckoViewFetchClient.kt#L114) +`fun read(bytes: `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`, off: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, len: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-nightly/src/main/java/mozilla/components/browser/engine/gecko/fetch/GeckoViewFetchClient.kt#L119) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/-init-.md b/docs/api/mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/-init-.md new file mode 100644 index 00000000000..da2db1a1ea8 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko.fetch](../index.md) / [GeckoViewFetchClient](index.md) / [<init>](./-init-.md) + +# <init> + +`GeckoViewFetchClient(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, runtime: `[`GeckoRuntime`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoRuntime.html)` = GeckoRuntime.getDefault(context), maxReadTimeOut: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)`> = Pair(MAX_READ_TIMEOUT_MINUTES, TimeUnit.MINUTES))` + +GeckoView ([GeckoWebExecutor](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoWebExecutor.html)) based implementation of [Client](../../mozilla.components.concept.fetch/-client/index.md). + diff --git a/docs/api/mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/-m-a-x_-r-e-a-d_-t-i-m-e-o-u-t_-m-i-n-u-t-e-s.md b/docs/api/mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/-m-a-x_-r-e-a-d_-t-i-m-e-o-u-t_-m-i-n-u-t-e-s.md new file mode 100644 index 00000000000..459c08530c8 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/-m-a-x_-r-e-a-d_-t-i-m-e-o-u-t_-m-i-n-u-t-e-s.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko.fetch](../index.md) / [GeckoViewFetchClient](index.md) / [MAX_READ_TIMEOUT_MINUTES](./-m-a-x_-r-e-a-d_-t-i-m-e-o-u-t_-m-i-n-u-t-e-s.md) + +# MAX_READ_TIMEOUT_MINUTES + +`const val MAX_READ_TIMEOUT_MINUTES: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-nightly/src/main/java/mozilla/components/browser/engine/gecko/fetch/GeckoViewFetchClient.kt#L62) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/fetch.md b/docs/api/mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/fetch.md new file mode 100644 index 00000000000..80419768e0a --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/fetch.md @@ -0,0 +1,35 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko.fetch](../index.md) / [GeckoViewFetchClient](index.md) / [fetch](./fetch.md) + +# fetch + +`fun fetch(request: `[`Request`](../../mozilla.components.concept.fetch/-request/index.md)`): `[`Response`](../../mozilla.components.concept.fetch/-response/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-nightly/src/main/java/mozilla/components/browser/engine/gecko/fetch/GeckoViewFetchClient.kt#L39) + +Overrides [Client.fetch](../../mozilla.components.concept.fetch/-client/fetch.md) + +Starts the process of fetching a resource from the network as described by the [Request](../../mozilla.components.concept.fetch/-request/index.md) object. + +A [Response](../../mozilla.components.concept.fetch/-response/index.md) may keep references to open streams. Therefore it's important to always close the [Response](../../mozilla.components.concept.fetch/-response/index.md) or +its [Response.Body](../../mozilla.components.concept.fetch/-response/-body/index.md). + +Use the `use()` extension method when performing multiple operations on the [Response](../../mozilla.components.concept.fetch/-response/index.md) object: + +``` Kotlin +client.fetch(request).use { response -> + // Use response. Resources will get released automatically at the end of the block. +} +``` + +Alternatively you can use multiple `use*()` methods on the [Response.Body](../../mozilla.components.concept.fetch/-response/-body/index.md) object. + +### Parameters + +`request` - The request to be executed by this [Client](../../mozilla.components.concept.fetch/-client/index.md). + +### Exceptions + +`IOException` - if the request could not be executed due to cancellation, a connectivity problem or a +timeout. + +**Return** +The [Response](../../mozilla.components.concept.fetch/-response/index.md) returned by the server. + diff --git a/docs/api/mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/index.md b/docs/api/mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/index.md new file mode 100644 index 00000000000..e9f19bb9527 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/index.md @@ -0,0 +1,31 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko.fetch](../index.md) / [GeckoViewFetchClient](./index.md) + +# GeckoViewFetchClient + +`class GeckoViewFetchClient : `[`Client`](../../mozilla.components.concept.fetch/-client/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-nightly/src/main/java/mozilla/components/browser/engine/gecko/fetch/GeckoViewFetchClient.kt#L29) + +GeckoView ([GeckoWebExecutor](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoWebExecutor.html)) based implementation of [Client](../../mozilla.components.concept.fetch/-client/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `GeckoViewFetchClient(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, runtime: `[`GeckoRuntime`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoRuntime.html)` = GeckoRuntime.getDefault(context), maxReadTimeOut: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)`> = Pair(MAX_READ_TIMEOUT_MINUTES, TimeUnit.MINUTES))`
GeckoView ([GeckoWebExecutor](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoWebExecutor.html)) based implementation of [Client](../../mozilla.components.concept.fetch/-client/index.md). | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [defaultHeaders](../../mozilla.components.concept.fetch/-client/default-headers.md) | `val defaultHeaders: `[`Headers`](../../mozilla.components.concept.fetch/-headers/index.md)
List of default headers that should be added to every request unless overridden by the headers in the request. | + +### Functions + +| Name | Summary | +|---|---| +| [fetch](fetch.md) | `fun fetch(request: `[`Request`](../../mozilla.components.concept.fetch/-request/index.md)`): `[`Response`](../../mozilla.components.concept.fetch/-response/index.md)
Starts the process of fetching a resource from the network as described by the [Request](../../mozilla.components.concept.fetch/-request/index.md) object. | + +### Companion Object Properties + +| Name | Summary | +|---|---| +| [MAX_READ_TIMEOUT_MINUTES](-m-a-x_-r-e-a-d_-t-i-m-e-o-u-t_-m-i-n-u-t-e-s.md) | `const val MAX_READ_TIMEOUT_MINUTES: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | diff --git a/docs/api/mozilla.components.browser.engine.gecko.fetch/index.md b/docs/api/mozilla.components.browser.engine.gecko.fetch/index.md new file mode 100644 index 00000000000..d6377e0dc65 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.fetch/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.browser.engine.gecko.fetch](./index.md) + +## Package mozilla.components.browser.engine.gecko.fetch + +### Types + +| Name | Summary | +|---|---| +| [ByteBufferInputStream](-byte-buffer-input-stream/index.md) | `class ByteBufferInputStream : `[`InputStream`](https://developer.android.com/reference/java/io/InputStream.html) | +| [GeckoViewFetchClient](-gecko-view-fetch-client/index.md) | `class GeckoViewFetchClient : `[`Client`](../mozilla.components.concept.fetch/-client/index.md)
GeckoView ([GeckoWebExecutor](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoWebExecutor.html)) based implementation of [Client](../mozilla.components.concept.fetch/-client/index.md). | diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-app/-init-.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-app/-init-.md new file mode 100644 index 00000000000..266166349fa --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-app/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.gecko.permission](../../index.md) / [GeckoPermissionRequest](../index.md) / [App](index.md) / [<init>](./-init-.md) + +# <init> + +`App(nativePermissions: `[`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)`>, callback: `[`Callback`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession/PermissionDelegate/Callback.html)`)` + +Represents a gecko-based application permission request. + diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-app/index.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-app/index.md new file mode 100644 index 00000000000..472b805f272 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-app/index.md @@ -0,0 +1,38 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.gecko.permission](../../index.md) / [GeckoPermissionRequest](../index.md) / [App](./index.md) + +# App + +`data class App : `[`GeckoPermissionRequest`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/permission/GeckoPermissionRequest.kt#L71) + +Represents a gecko-based application permission request. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `App(nativePermissions: `[`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)`>, callback: `[`Callback`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession/PermissionDelegate/Callback.html)`)`
Represents a gecko-based application permission request. | + +### Properties + +| Name | Summary | +|---|---| +| [uri](uri.md) | `val uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
the URI of the content requesting the permissions. | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [permissions](../permissions.md) | `open val permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../../../mozilla.components.concept.engine.permission/-permission/index.md)`>`
the list of requested permissions. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [grant](../grant.md) | `open fun grant(permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../../../mozilla.components.concept.engine.permission/-permission/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Grants the provided permissions, or all requested permissions, if none are provided. | +| [reject](../reject.md) | `open fun reject(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Rejects the requested permissions. | + +### Companion Object Properties + +| Name | Summary | +|---|---| +| [permissionsMap](permissions-map.md) | `val permissionsMap: `[`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)`, `[`Permission`](../../../mozilla.components.concept.engine.permission/-permission/index.md)`>` | diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-app/permissions-map.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-app/permissions-map.md new file mode 100644 index 00000000000..1cde5a016ef --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-app/permissions-map.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.gecko.permission](../../index.md) / [GeckoPermissionRequest](../index.md) / [App](index.md) / [permissionsMap](./permissions-map.md) + +# permissionsMap + +`val permissionsMap: `[`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)`, `[`Permission`](../../../mozilla.components.concept.engine.permission/-permission/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/permission/GeckoPermissionRequest.kt#L81) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-app/uri.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-app/uri.md new file mode 100644 index 00000000000..178a28cff40 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-app/uri.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.gecko.permission](../../index.md) / [GeckoPermissionRequest](../index.md) / [App](index.md) / [uri](./uri.md) + +# uri + +`val uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/permission/GeckoPermissionRequest.kt#L78) + +Overrides [PermissionRequest.uri](../../../mozilla.components.concept.engine.permission/-permission-request/uri.md) + +the URI of the content requesting the permissions. + +### Property + +`uri` - the URI of the content requesting the permissions. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-content/-init-.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-content/-init-.md new file mode 100644 index 00000000000..844e97e770d --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-content/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.gecko.permission](../../index.md) / [GeckoPermissionRequest](../index.md) / [Content](index.md) / [<init>](./-init-.md) + +# <init> + +`Content(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, type: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, callback: `[`Callback`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession/PermissionDelegate/Callback.html)`)` + +Represents a gecko-based content permission request. + diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-content/index.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-content/index.md new file mode 100644 index 00000000000..641896c6b8a --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-content/index.md @@ -0,0 +1,38 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.gecko.permission](../../index.md) / [GeckoPermissionRequest](../index.md) / [Content](./index.md) + +# Content + +`data class Content : `[`GeckoPermissionRequest`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/permission/GeckoPermissionRequest.kt#L46) + +Represents a gecko-based content permission request. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Content(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, type: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, callback: `[`Callback`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession/PermissionDelegate/Callback.html)`)`
Represents a gecko-based content permission request. | + +### Properties + +| Name | Summary | +|---|---| +| [uri](uri.md) | `val uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
the URI of the content requesting the permissions. | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [permissions](../permissions.md) | `open val permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../../../mozilla.components.concept.engine.permission/-permission/index.md)`>`
the list of requested permissions. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [grant](../grant.md) | `open fun grant(permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../../../mozilla.components.concept.engine.permission/-permission/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Grants the provided permissions, or all requested permissions, if none are provided. | +| [reject](../reject.md) | `open fun reject(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Rejects the requested permissions. | + +### Companion Object Properties + +| Name | Summary | +|---|---| +| [permissionsMap](permissions-map.md) | `val permissionsMap: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `[`Permission`](../../../mozilla.components.concept.engine.permission/-permission/index.md)`>` | diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-content/permissions-map.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-content/permissions-map.md new file mode 100644 index 00000000000..3b905ea5189 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-content/permissions-map.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.gecko.permission](../../index.md) / [GeckoPermissionRequest](../index.md) / [Content](index.md) / [permissionsMap](./permissions-map.md) + +# permissionsMap + +`val permissionsMap: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `[`Permission`](../../../mozilla.components.concept.engine.permission/-permission/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/permission/GeckoPermissionRequest.kt#L55) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-content/uri.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-content/uri.md new file mode 100644 index 00000000000..58c72006901 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-content/uri.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.gecko.permission](../../index.md) / [GeckoPermissionRequest](../index.md) / [Content](index.md) / [uri](./uri.md) + +# uri + +`val uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/permission/GeckoPermissionRequest.kt#L47) + +Overrides [PermissionRequest.uri](../../../mozilla.components.concept.engine.permission/-permission-request/uri.md) + +the URI of the content requesting the permissions. + +### Property + +`uri` - the URI of the content requesting the permissions. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/-init-.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/-init-.md new file mode 100644 index 00000000000..e28892b9737 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.gecko.permission](../../index.md) / [GeckoPermissionRequest](../index.md) / [Media](index.md) / [<init>](./-init-.md) + +# <init> + +`Media(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, videoSources: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`MediaSource`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession/PermissionDelegate/MediaSource.html)`>, audioSources: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`MediaSource`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession/PermissionDelegate/MediaSource.html)`>, callback: `[`MediaCallback`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession/PermissionDelegate/MediaCallback.html)`)` + +Represents a gecko-based media permission request. + diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/contains-video-and-audio-sources.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/contains-video-and-audio-sources.md new file mode 100644 index 00000000000..f0fa0394b71 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/contains-video-and-audio-sources.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.gecko.permission](../../index.md) / [GeckoPermissionRequest](../index.md) / [Media](index.md) / [containsVideoAndAudioSources](./contains-video-and-audio-sources.md) + +# containsVideoAndAudioSources + +`fun containsVideoAndAudioSources(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/permission/GeckoPermissionRequest.kt#L114) + +Overrides [PermissionRequest.containsVideoAndAudioSources](../../../mozilla.components.concept.engine.permission/-permission-request/contains-video-and-audio-sources.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/grant.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/grant.md new file mode 100644 index 00000000000..c5d87f0e1f9 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/grant.md @@ -0,0 +1,14 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.gecko.permission](../../index.md) / [GeckoPermissionRequest](../index.md) / [Media](index.md) / [grant](./grant.md) + +# grant + +`fun grant(permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../../../mozilla.components.concept.engine.permission/-permission/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/permission/GeckoPermissionRequest.kt#L108) + +Overrides [GeckoPermissionRequest.grant](../grant.md) + +Grants the provided permissions, or all requested permissions, if none +are provided. + +### Parameters + +`permissions` - the permissions to grant. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/index.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/index.md new file mode 100644 index 00000000000..c736e8eca54 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/index.md @@ -0,0 +1,39 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.gecko.permission](../../index.md) / [GeckoPermissionRequest](../index.md) / [Media](./index.md) + +# Media + +`data class Media : `[`GeckoPermissionRequest`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/permission/GeckoPermissionRequest.kt#L100) + +Represents a gecko-based media permission request. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Media(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, videoSources: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`MediaSource`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession/PermissionDelegate/MediaSource.html)`>, audioSources: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`MediaSource`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession/PermissionDelegate/MediaSource.html)`>, callback: `[`MediaCallback`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession/PermissionDelegate/MediaCallback.html)`)`
Represents a gecko-based media permission request. | + +### Properties + +| Name | Summary | +|---|---| +| [uri](uri.md) | `val uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
the URI of the content requesting the permissions. | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [permissions](../permissions.md) | `open val permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../../../mozilla.components.concept.engine.permission/-permission/index.md)`>`
the list of requested permissions. | + +### Functions + +| Name | Summary | +|---|---| +| [containsVideoAndAudioSources](contains-video-and-audio-sources.md) | `fun containsVideoAndAudioSources(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [grant](grant.md) | `fun grant(permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../../../mozilla.components.concept.engine.permission/-permission/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Grants the provided permissions, or all requested permissions, if none are provided. | +| [reject](reject.md) | `fun reject(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Rejects the requested permissions. | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [mapPermission](map-permission.md) | `fun mapPermission(mediaSource: `[`MediaSource`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession/PermissionDelegate/MediaSource.html)`): `[`Permission`](../../../mozilla.components.concept.engine.permission/-permission/index.md) | diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/map-permission.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/map-permission.md new file mode 100644 index 00000000000..5f800d2f18c --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/map-permission.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.gecko.permission](../../index.md) / [GeckoPermissionRequest](../index.md) / [Media](index.md) / [mapPermission](./map-permission.md) + +# mapPermission + +`fun mapPermission(mediaSource: `[`MediaSource`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession/PermissionDelegate/MediaSource.html)`): `[`Permission`](../../../mozilla.components.concept.engine.permission/-permission/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/permission/GeckoPermissionRequest.kt#L124) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/reject.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/reject.md new file mode 100644 index 00000000000..04a6fde4e38 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/reject.md @@ -0,0 +1,10 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.gecko.permission](../../index.md) / [GeckoPermissionRequest](../index.md) / [Media](index.md) / [reject](./reject.md) + +# reject + +`fun reject(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/permission/GeckoPermissionRequest.kt#L118) + +Overrides [GeckoPermissionRequest.reject](../reject.md) + +Rejects the requested permissions. + diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/uri.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/uri.md new file mode 100644 index 00000000000..01bc4ff47d9 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/-media/uri.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.gecko.permission](../../index.md) / [GeckoPermissionRequest](../index.md) / [Media](index.md) / [uri](./uri.md) + +# uri + +`val uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/permission/GeckoPermissionRequest.kt#L101) + +Overrides [PermissionRequest.uri](../../../mozilla.components.concept.engine.permission/-permission-request/uri.md) + +the URI of the content requesting the permissions. + +### Property + +`uri` - the URI of the content requesting the permissions. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/grant.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/grant.md new file mode 100644 index 00000000000..5036b95b67f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/grant.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko.permission](../index.md) / [GeckoPermissionRequest](index.md) / [grant](./grant.md) + +# grant + +`open fun grant(permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../../mozilla.components.concept.engine.permission/-permission/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/permission/GeckoPermissionRequest.kt#L147) + +Overrides [PermissionRequest.grant](../../mozilla.components.concept.engine.permission/-permission-request/grant.md) + +Grants the provided permissions, or all requested permissions, if none +are provided. + +### Parameters + +`permissions` - the permissions to grant. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/index.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/index.md new file mode 100644 index 00000000000..8015410c95c --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/index.md @@ -0,0 +1,49 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko.permission](../index.md) / [GeckoPermissionRequest](./index.md) + +# GeckoPermissionRequest + +`sealed class GeckoPermissionRequest : `[`PermissionRequest`](../../mozilla.components.concept.engine.permission/-permission-request/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/permission/GeckoPermissionRequest.kt#L33) + +Gecko-based implementation of [PermissionRequest](../../mozilla.components.concept.engine.permission/-permission-request/index.md). + +### Types + +| Name | Summary | +|---|---| +| [App](-app/index.md) | `data class App : `[`GeckoPermissionRequest`](./index.md)
Represents a gecko-based application permission request. | +| [Content](-content/index.md) | `data class Content : `[`GeckoPermissionRequest`](./index.md)
Represents a gecko-based content permission request. | +| [Media](-media/index.md) | `data class Media : `[`GeckoPermissionRequest`](./index.md)
Represents a gecko-based media permission request. | + +### Properties + +| Name | Summary | +|---|---| +| [permissions](permissions.md) | `open val permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../../mozilla.components.concept.engine.permission/-permission/index.md)`>`
the list of requested permissions. | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [uri](../../mozilla.components.concept.engine.permission/-permission-request/uri.md) | `abstract val uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
The origin URI which caused the permissions to be requested. | + +### Functions + +| Name | Summary | +|---|---| +| [grant](grant.md) | `open fun grant(permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../../mozilla.components.concept.engine.permission/-permission/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Grants the provided permissions, or all requested permissions, if none are provided. | +| [reject](reject.md) | `open fun reject(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Rejects the requested permissions. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [containsVideoAndAudioSources](../../mozilla.components.concept.engine.permission/-permission-request/contains-video-and-audio-sources.md) | `open fun containsVideoAndAudioSources(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [grantIf](../../mozilla.components.concept.engine.permission/-permission-request/grant-if.md) | `open fun grantIf(predicate: (`[`Permission`](../../mozilla.components.concept.engine.permission/-permission/index.md)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Grants this permission request if the provided predicate is true for any of the requested permissions. | + +### Inheritors + +| Name | Summary | +|---|---| +| [App](-app/index.md) | `data class App : `[`GeckoPermissionRequest`](./index.md)
Represents a gecko-based application permission request. | +| [Content](-content/index.md) | `data class Content : `[`GeckoPermissionRequest`](./index.md)
Represents a gecko-based content permission request. | +| [Media](-media/index.md) | `data class Media : `[`GeckoPermissionRequest`](./index.md)
Represents a gecko-based media permission request. | diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/permissions.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/permissions.md new file mode 100644 index 00000000000..30f8dd31096 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/permissions.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko.permission](../index.md) / [GeckoPermissionRequest](index.md) / [permissions](./permissions.md) + +# permissions + +`open val permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../../mozilla.components.concept.engine.permission/-permission/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/permission/GeckoPermissionRequest.kt#L34) + +Overrides [PermissionRequest.permissions](../../mozilla.components.concept.engine.permission/-permission-request/permissions.md) + +the list of requested permissions. + +### Property + +`permissions` - the list of requested permissions. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/reject.md b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/reject.md new file mode 100644 index 00000000000..26705aaf34f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/reject.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko.permission](../index.md) / [GeckoPermissionRequest](index.md) / [reject](./reject.md) + +# reject + +`open fun reject(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/permission/GeckoPermissionRequest.kt#L151) + +Overrides [PermissionRequest.reject](../../mozilla.components.concept.engine.permission/-permission-request/reject.md) + +Rejects the requested permissions. + diff --git a/docs/api/mozilla.components.browser.engine.gecko.permission/index.md b/docs/api/mozilla.components.browser.engine.gecko.permission/index.md new file mode 100644 index 00000000000..f65386f1f9f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.permission/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.browser.engine.gecko.permission](./index.md) + +## Package mozilla.components.browser.engine.gecko.permission + +### Types + +| Name | Summary | +|---|---| +| [GeckoPermissionRequest](-gecko-permission-request/index.md) | `sealed class GeckoPermissionRequest : `[`PermissionRequest`](../mozilla.components.concept.engine.permission/-permission-request/index.md)
Gecko-based implementation of [PermissionRequest](../mozilla.components.concept.engine.permission/-permission-request/index.md). | diff --git a/docs/api/mozilla.components.browser.engine.gecko.prompt/-gecko-choice.md b/docs/api/mozilla.components.browser.engine.gecko.prompt/-gecko-choice.md new file mode 100644 index 00000000000..2031dff931b --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.prompt/-gecko-choice.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.browser.engine.gecko.prompt](index.md) / [GeckoChoice](./-gecko-choice.md) + +# GeckoChoice + +`typealias GeckoChoice = `[`Choice`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession/PromptDelegate/Choice.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/prompt/GeckoPromptDelegate.kt#L51) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko.prompt/index.md b/docs/api/mozilla.components.browser.engine.gecko.prompt/index.md new file mode 100644 index 00000000000..69e24dc42e9 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko.prompt/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.browser.engine.gecko.prompt](./index.md) + +## Package mozilla.components.browser.engine.gecko.prompt + +### Type Aliases + +| Name | Summary | +|---|---| +| [GeckoChoice](-gecko-choice.md) | `typealias GeckoChoice = `[`Choice`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession/PromptDelegate/Choice.html) | diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session-state/from-j-s-o-n.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session-state/from-j-s-o-n.md new file mode 100644 index 00000000000..4fb07e26092 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session-state/from-j-s-o-n.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSessionState](index.md) / [fromJSON](./from-j-s-o-n.md) + +# fromJSON + +`fun fromJSON(json: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`GeckoEngineSessionState`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionState.kt#L27) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session-state/index.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session-state/index.md new file mode 100644 index 00000000000..3cb40882f8b --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session-state/index.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSessionState](./index.md) + +# GeckoEngineSessionState + +`class GeckoEngineSessionState : `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionState.kt#L14) + +### Functions + +| Name | Summary | +|---|---| +| [toJSON](to-j-s-o-n.md) | `fun toJSON(): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)
Create a JSON representation of this state that can be saved to disk. | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [fromJSON](from-j-s-o-n.md) | `fun fromJSON(json: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`GeckoEngineSessionState`](./index.md) | diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session-state/to-j-s-o-n.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session-state/to-j-s-o-n.md new file mode 100644 index 00000000000..a2ad1525e94 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session-state/to-j-s-o-n.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSessionState](index.md) / [toJSON](./to-j-s-o-n.md) + +# toJSON + +`fun toJSON(): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionState.kt#L17) + +Overrides [EngineSessionState.toJSON](../../mozilla.components.concept.engine/-engine-session-state/to-j-s-o-n.md) + +Create a JSON representation of this state that can be saved to disk. + +When reading JSON from disk [Engine.createSessionState](#) can be used to turn it back into an [EngineSessionState](../../mozilla.components.concept.engine/-engine-session-state/index.md) +instance. + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/-init-.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/-init-.md new file mode 100644 index 00000000000..a50437e9298 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/-init-.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [<init>](./-init-.md) + +# <init> + +`GeckoEngineSession(runtime: `[`GeckoRuntime`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoRuntime.html)`, privateMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, defaultSettings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md)`? = null, geckoSessionProvider: () -> `[`GeckoSession`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession.html)` = { + val settings = GeckoSessionSettings.Builder() + .usePrivateMode(privateMode) + .build() + GeckoSession(settings) + }, context: `[`CoroutineContext`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html)` = Dispatchers.IO)` + +Gecko-based EngineSession implementation. + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/capture-thumbnail.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/capture-thumbnail.md new file mode 100644 index 00000000000..5b1fcc7ce26 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/capture-thumbnail.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [captureThumbnail](./capture-thumbnail.md) + +# captureThumbnail + +`fun captureThumbnail(): `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L562) + +Overrides [EngineSession.captureThumbnail](../../mozilla.components.concept.engine/-engine-session/capture-thumbnail.md) + +Takes a screenshot of the actual tab + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/clear-data.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/clear-data.md new file mode 100644 index 00000000000..496616e6200 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/clear-data.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [clearData](./clear-data.md) + +# clearData + +`fun clearData(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L213) + +Overrides [EngineSession.clearData](../../mozilla.components.concept.engine/-engine-session/clear-data.md) + +See [EngineSession.clearData](../../mozilla.components.concept.engine/-engine-session/clear-data.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/clear-find-matches.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/clear-find-matches.md new file mode 100644 index 00000000000..3cb6ee0a260 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/clear-find-matches.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [clearFindMatches](./clear-find-matches.md) + +# clearFindMatches + +`fun clearFindMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L249) + +Overrides [EngineSession.clearFindMatches](../../mozilla.components.concept.engine/-engine-session/clear-find-matches.md) + +See [EngineSession.clearFindMatches](../../mozilla.components.concept.engine/-engine-session/clear-find-matches.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/close.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/close.md new file mode 100644 index 00000000000..53f94a07ec3 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/close.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [close](./close.md) + +# close + +`fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L263) + +Overrides [EngineSession.close](../../mozilla.components.concept.engine/-engine-session/close.md) + +See [EngineSession.close](../../mozilla.components.concept.engine/-engine-session/close.md). + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/coroutine-context.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/coroutine-context.md new file mode 100644 index 00000000000..4a52673e5ff --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/coroutine-context.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [coroutineContext](./coroutine-context.md) + +# coroutineContext + +`val coroutineContext: `[`CoroutineContext`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L75) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/disable-tracking-protection.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/disable-tracking-protection.md new file mode 100644 index 00000000000..400e2ed74ee --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/disable-tracking-protection.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [disableTrackingProtection](./disable-tracking-protection.md) + +# disableTrackingProtection + +`fun disableTrackingProtection(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L184) + +Overrides [EngineSession.disableTrackingProtection](../../mozilla.components.concept.engine/-engine-session/disable-tracking-protection.md) + +See [EngineSession.disableTrackingProtection](../../mozilla.components.concept.engine/-engine-session/disable-tracking-protection.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/enable-tracking-protection.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/enable-tracking-protection.md new file mode 100644 index 00000000000..cb1348ca643 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/enable-tracking-protection.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [enableTrackingProtection](./enable-tracking-protection.md) + +# enableTrackingProtection + +`fun enableTrackingProtection(policy: `[`TrackingProtectionPolicy`](../../mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L171) + +Overrides [EngineSession.enableTrackingProtection](../../mozilla.components.concept.engine/-engine-session/enable-tracking-protection.md) + +See [EngineSession.enableTrackingProtection](../../mozilla.components.concept.engine/-engine-session/enable-tracking-protection.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/exit-full-screen-mode.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/exit-full-screen-mode.md new file mode 100644 index 00000000000..2493bce40f9 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/exit-full-screen-mode.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [exitFullScreenMode](./exit-full-screen-mode.md) + +# exitFullScreenMode + +`fun exitFullScreenMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L256) + +Overrides [EngineSession.exitFullScreenMode](../../mozilla.components.concept.engine/-engine-session/exit-full-screen-mode.md) + +See [EngineSession.exitFullScreenMode](../../mozilla.components.concept.engine/-engine-session/exit-full-screen-mode.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-all.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-all.md new file mode 100644 index 00000000000..72187dabf0c --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-all.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [findAll](./find-all.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L220) + +Overrides [EngineSession.findAll](../../mozilla.components.concept.engine/-engine-session/find-all.md) + +See [EngineSession.findAll](../../mozilla.components.concept.engine/-engine-session/find-all.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-next.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-next.md new file mode 100644 index 00000000000..ce4bca08011 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/find-next.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [findNext](./find-next.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L235) + +Overrides [EngineSession.findNext](../../mozilla.components.concept.engine/-engine-session/find-next.md) + +See [EngineSession.findNext](../../mozilla.components.concept.engine/-engine-session/find-next.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-back.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-back.md new file mode 100644 index 00000000000..663b1b3007e --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-back.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [goBack](./go-back.md) + +# goBack + +`fun goBack(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L116) + +Overrides [EngineSession.goBack](../../mozilla.components.concept.engine/-engine-session/go-back.md) + +See [EngineSession.goBack](../../mozilla.components.concept.engine/-engine-session/go-back.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-forward.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-forward.md new file mode 100644 index 00000000000..46a2765f33f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/go-forward.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [goForward](./go-forward.md) + +# goForward + +`fun goForward(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L123) + +Overrides [EngineSession.goForward](../../mozilla.components.concept.engine/-engine-session/go-forward.md) + +See [EngineSession.goForward](../../mozilla.components.concept.engine/-engine-session/go-forward.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/handle-long-click.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/handle-long-click.md new file mode 100644 index 00000000000..84b2fb1d233 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/handle-long-click.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [handleLongClick](./handle-long-click.md) + +# 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`](../../mozilla.components.concept.engine/-hit-result/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L527) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/index.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/index.md new file mode 100644 index 00000000000..4b7b90d60ce --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/index.md @@ -0,0 +1,49 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](./index.md) + +# GeckoEngineSession + +`class GeckoEngineSession : CoroutineScope, `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L45) + +Gecko-based EngineSession implementation. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `GeckoEngineSession(runtime: `[`GeckoRuntime`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoRuntime.html)`, privateMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, defaultSettings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md)`? = null, geckoSessionProvider: () -> `[`GeckoSession`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession.html)` = { + val settings = GeckoSessionSettings.Builder() + .usePrivateMode(privateMode) + .build() + GeckoSession(settings) + }, context: `[`CoroutineContext`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html)` = Dispatchers.IO)`
Gecko-based EngineSession implementation. | + +### Properties + +| Name | Summary | +|---|---| +| [coroutineContext](coroutine-context.md) | `val coroutineContext: `[`CoroutineContext`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html) | +| [settings](settings.md) | `val settings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md)
See [EngineSession.settings](../../mozilla.components.concept.engine/-engine-session/settings.md) | + +### Functions + +| Name | Summary | +|---|---| +| [captureThumbnail](capture-thumbnail.md) | `fun captureThumbnail(): `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?`
Takes a screenshot of the actual tab | +| [clearData](clear-data.md) | `fun clearData(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.clearData](../../mozilla.components.concept.engine/-engine-session/clear-data.md) | +| [clearFindMatches](clear-find-matches.md) | `fun clearFindMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.clearFindMatches](../../mozilla.components.concept.engine/-engine-session/clear-find-matches.md) | +| [close](close.md) | `fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.close](../../mozilla.components.concept.engine/-engine-session/close.md). | +| [disableTrackingProtection](disable-tracking-protection.md) | `fun disableTrackingProtection(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.disableTrackingProtection](../../mozilla.components.concept.engine/-engine-session/disable-tracking-protection.md) | +| [enableTrackingProtection](enable-tracking-protection.md) | `fun enableTrackingProtection(policy: `[`TrackingProtectionPolicy`](../../mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.enableTrackingProtection](../../mozilla.components.concept.engine/-engine-session/enable-tracking-protection.md) | +| [exitFullScreenMode](exit-full-screen-mode.md) | `fun exitFullScreenMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.exitFullScreenMode](../../mozilla.components.concept.engine/-engine-session/exit-full-screen-mode.md) | +| [findAll](find-all.md) | `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](../../mozilla.components.concept.engine/-engine-session/find-all.md) | +| [findNext](find-next.md) | `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](../../mozilla.components.concept.engine/-engine-session/find-next.md) | +| [goBack](go-back.md) | `fun goBack(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.goBack](../../mozilla.components.concept.engine/-engine-session/go-back.md) | +| [goForward](go-forward.md) | `fun goForward(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.goForward](../../mozilla.components.concept.engine/-engine-session/go-forward.md) | +| [handleLongClick](handle-long-click.md) | `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`](../../mozilla.components.concept.engine/-hit-result/index.md)`?` | +| [loadData](load-data.md) | `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](../../mozilla.components.concept.engine/-engine-session/load-data.md) | +| [loadUrl](load-url.md) | `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](../../mozilla.components.concept.engine/-engine-session/load-url.md) | +| [reload](reload.md) | `fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.reload](../../mozilla.components.concept.engine/-engine-session/reload.md) | +| [restoreState](restore-state.md) | `fun restoreState(state: `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.restoreState](../../mozilla.components.concept.engine/-engine-session/restore-state.md) | +| [saveState](save-state.md) | `fun saveState(): `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md)
See [EngineSession.saveState](../../mozilla.components.concept.engine/-engine-session/save-state.md) | +| [stopLoading](stop-loading.md) | `fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.stopLoading](../../mozilla.components.concept.engine/-engine-session/stop-loading.md) | +| [toggleDesktopMode](toggle-desktop-mode.md) | `fun toggleDesktopMode(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](../../mozilla.components.concept.engine/-engine-session/settings.md) | diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-data.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-data.md new file mode 100644 index 00000000000..0d21c5f0f02 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-data.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [loadData](./load-data.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L92) + +Overrides [EngineSession.loadData](../../mozilla.components.concept.engine/-engine-session/load-data.md) + +See [EngineSession.loadData](../../mozilla.components.concept.engine/-engine-session/load-data.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-url.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-url.md new file mode 100644 index 00000000000..9af77dcca17 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/load-url.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [loadUrl](./load-url.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L85) + +Overrides [EngineSession.loadUrl](../../mozilla.components.concept.engine/-engine-session/load-url.md) + +See [EngineSession.loadUrl](../../mozilla.components.concept.engine/-engine-session/load-url.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/reload.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/reload.md new file mode 100644 index 00000000000..a50e43b78e1 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/reload.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [reload](./reload.md) + +# reload + +`fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L109) + +Overrides [EngineSession.reload](../../mozilla.components.concept.engine/-engine-session/reload.md) + +See [EngineSession.reload](../../mozilla.components.concept.engine/-engine-session/reload.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/restore-state.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/restore-state.md new file mode 100644 index 00000000000..3e4c901c994 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/restore-state.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [restoreState](./restore-state.md) + +# restoreState + +`fun restoreState(state: `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L156) + +Overrides [EngineSession.restoreState](../../mozilla.components.concept.engine/-engine-session/restore-state.md) + +See [EngineSession.restoreState](../../mozilla.components.concept.engine/-engine-session/restore-state.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/save-state.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/save-state.md new file mode 100644 index 00000000000..7bdf19b7ad1 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/save-state.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [saveState](./save-state.md) + +# saveState + +`fun saveState(): `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L137) + +Overrides [EngineSession.saveState](../../mozilla.components.concept.engine/-engine-session/save-state.md) + +See [EngineSession.saveState](../../mozilla.components.concept.engine/-engine-session/save-state.md) + +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/mozilla.components.browser.engine.gecko/-gecko-engine-session/settings.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/settings.md new file mode 100644 index 00000000000..50617c5475d --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/settings.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [settings](./settings.md) + +# settings + +`val settings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L65) + +Overrides [EngineSession.settings](../../mozilla.components.concept.engine/-engine-session/settings.md) + +See [EngineSession.settings](../../mozilla.components.concept.engine/-engine-session/settings.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/stop-loading.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/stop-loading.md new file mode 100644 index 00000000000..ea3ec5e4b0c --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/stop-loading.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [stopLoading](./stop-loading.md) + +# stopLoading + +`fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L102) + +Overrides [EngineSession.stopLoading](../../mozilla.components.concept.engine/-engine-session/stop-loading.md) + +See [EngineSession.stopLoading](../../mozilla.components.concept.engine/-engine-session/stop-loading.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/toggle-desktop-mode.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/toggle-desktop-mode.md new file mode 100644 index 00000000000..1164b2f9105 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-session/toggle-desktop-mode.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineSession](index.md) / [toggleDesktopMode](./toggle-desktop-mode.md) + +# toggleDesktopMode + +`fun toggleDesktopMode(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt#L192) + +Overrides [EngineSession.toggleDesktopMode](../../mozilla.components.concept.engine/-engine-session/toggle-desktop-mode.md) + +See [EngineSession.settings](../../mozilla.components.concept.engine/-engine-session/settings.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-view/-init-.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-view/-init-.md new file mode 100644 index 00000000000..5aa8ecf5290 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-view/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineView](index.md) / [<init>](./-init-.md) + +# <init> + +`GeckoEngineView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)` + +Gecko-based EngineView implementation. + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-view/can-scroll-vertically-down.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-view/can-scroll-vertically-down.md new file mode 100644 index 00000000000..d252c9a4a3b --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-view/can-scroll-vertically-down.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineView](index.md) / [canScrollVerticallyDown](./can-scroll-vertically-down.md) + +# canScrollVerticallyDown + +`fun canScrollVerticallyDown(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineView.kt#L55) + +Overrides [EngineView.canScrollVerticallyDown](../../mozilla.components.concept.engine/-engine-view/can-scroll-vertically-down.md) + +Check if [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) can be scrolled vertically down. +true if can and false otherwise. + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-view/index.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-view/index.md new file mode 100644 index 00000000000..2903e7185f0 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-view/index.md @@ -0,0 +1,51 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineView](./index.md) + +# GeckoEngineView + +`class GeckoEngineView : `[`FrameLayout`](https://developer.android.com/reference/android/widget/FrameLayout.html)`, `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineView.kt#L16) + +Gecko-based EngineView implementation. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `GeckoEngineView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)`
Gecko-based EngineView implementation. | + +### Functions + +| Name | Summary | +|---|---| +| [canScrollVerticallyDown](can-scroll-vertically-down.md) | `fun canScrollVerticallyDown(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Check if [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) can be scrolled vertically down. true if can and false otherwise. | +| [render](render.md) | `fun render(session: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Render the content of the given session. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [asView](../../mozilla.components.concept.engine/-engine-view/as-view.md) | `open fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html)
Convenience method to cast the implementation of this interface to an Android View object. | +| [onCreate](../../mozilla.components.concept.engine/-engine-view/on-create.md) | `open fun onCreate(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_CREATE](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | +| [onDestroy](../../mozilla.components.concept.engine/-engine-view/on-destroy.md) | `open fun onDestroy(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_DESTROY](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | +| [onPause](../../mozilla.components.concept.engine/-engine-view/on-pause.md) | `open fun onPause(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_PAUSE](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | +| [onResume](../../mozilla.components.concept.engine/-engine-view/on-resume.md) | `open fun onResume(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_RESUME](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | +| [onStart](../../mozilla.components.concept.engine/-engine-view/on-start.md) | `open fun onStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_START](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | +| [onStop](../../mozilla.components.concept.engine/-engine-view/on-stop.md) | `open fun onStop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_STOP](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | + +### Extension Properties + +| Name | Summary | +|---|---| +| [isLTR](../../mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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? | + +### Extension Functions + +| Name | Summary | +|---|---| +| [forEach](../../mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md) | `fun `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`.forEach(action: (`[`View`](https://developer.android.com/reference/android/view/View.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 the given action on each View in this ViewGroup. | +| [hideKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.hideKeyboard(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Hides the soft input window. | +| [isGone](../../mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [isVisible](../../mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [setPadding](../../mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.setPadding(padding: `[`Padding`](../../mozilla.components.support.base.android/-padding/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Set a padding using [Padding](../../mozilla.components.support.base.android/-padding/index.md) object. | +| [showKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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/mozilla.components.browser.engine.gecko/-gecko-engine-view/render.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-view/render.md new file mode 100644 index 00000000000..bc0904a2c3e --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine-view/render.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngineView](index.md) / [render](./render.md) + +# render + +`fun render(session: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineView.kt#L41) + +Overrides [EngineView.render](../../mozilla.components.concept.engine/-engine-view/render.md) + +Render the content of the given session. + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/-init-.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/-init-.md new file mode 100644 index 00000000000..5c6f072b4e6 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngine](index.md) / [<init>](./-init-.md) + +# <init> + +`GeckoEngine(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, defaultSettings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md)`? = null, runtime: `[`GeckoRuntime`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoRuntime.html)` = GeckoRuntime.getDefault(context), executorProvider: () -> `[`GeckoWebExecutor`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoWebExecutor.html)` = { GeckoWebExecutor(runtime) })` + +Gecko-based implementation of Engine interface. + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/create-session-state.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/create-session-state.md new file mode 100644 index 00000000000..96fdd5ea4ab --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/create-session-state.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngine](index.md) / [createSessionState](./create-session-state.md) + +# createSessionState + +`fun createSessionState(json: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngine.kt#L48) + +Overrides [Engine.createSessionState](../../mozilla.components.concept.engine/-engine/create-session-state.md) + +See [Engine.createSessionState](../../mozilla.components.concept.engine/-engine/create-session-state.md). + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/create-session.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/create-session.md new file mode 100644 index 00000000000..f70ff12ccce --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/create-session.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngine](index.md) / [createSession](./create-session.md) + +# createSession + +`fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngine.kt#L41) + +Overrides [Engine.createSession](../../mozilla.components.concept.engine/-engine/create-session.md) + +Creates a new Gecko-based EngineSession. + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/create-view.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/create-view.md new file mode 100644 index 00000000000..41b4932d31d --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/create-view.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngine](index.md) / [createView](./create-view.md) + +# createView + +`fun createView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`?): `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngine.kt#L34) + +Overrides [Engine.createView](../../mozilla.components.concept.engine/-engine/create-view.md) + +Creates a new Gecko-based EngineView. + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/index.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/index.md new file mode 100644 index 00000000000..dcd97da283f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/index.md @@ -0,0 +1,29 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngine](./index.md) + +# GeckoEngine + +`class GeckoEngine : `[`Engine`](../../mozilla.components.concept.engine/-engine/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngine.kt#L23) + +Gecko-based implementation of Engine interface. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `GeckoEngine(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, defaultSettings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md)`? = null, runtime: `[`GeckoRuntime`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoRuntime.html)` = GeckoRuntime.getDefault(context), executorProvider: () -> `[`GeckoWebExecutor`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoWebExecutor.html)` = { GeckoWebExecutor(runtime) })`
Gecko-based implementation of Engine interface. | + +### Properties + +| Name | Summary | +|---|---| +| [settings](settings.md) | `val settings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md)
See [Engine.settings](../../mozilla.components.concept.engine/-engine/settings.md) | + +### Functions + +| Name | Summary | +|---|---| +| [createSession](create-session.md) | `fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)
Creates a new Gecko-based EngineSession. | +| [createSessionState](create-session-state.md) | `fun createSessionState(json: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md)
See [Engine.createSessionState](../../mozilla.components.concept.engine/-engine/create-session-state.md). | +| [createView](create-view.md) | `fun createView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`?): `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md)
Creates a new Gecko-based EngineView. | +| [name](name.md) | `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. | +| [speculativeConnect](speculative-connect.md) | `fun speculativeConnect(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)
Opens a speculative connection to the host of [url](speculative-connect.md#mozilla.components.browser.engine.gecko.GeckoEngine$speculativeConnect(kotlin.String)/url). | diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/name.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/name.md new file mode 100644 index 00000000000..32a53893932 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/name.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngine](index.md) / [name](./name.md) + +# name + +`fun name(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngine.kt#L62) + +Overrides [Engine.name](../../mozilla.components.concept.engine/-engine/name.md) + +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/mozilla.components.browser.engine.gecko/-gecko-engine/settings.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/settings.md new file mode 100644 index 00000000000..23f6611e231 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/settings.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngine](index.md) / [settings](./settings.md) + +# settings + +`val settings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngine.kt#L67) + +Overrides [Engine.settings](../../mozilla.components.concept.engine/-engine/settings.md) + +See [Engine.settings](../../mozilla.components.concept.engine/-engine/settings.md) + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/speculative-connect.md b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/speculative-connect.md new file mode 100644 index 00000000000..6c945b56777 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-gecko-engine/speculative-connect.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [GeckoEngine](index.md) / [speculativeConnect](./speculative-connect.md) + +# speculativeConnect + +`fun speculativeConnect(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngine.kt#L58) + +Overrides [Engine.speculativeConnect](../../mozilla.components.concept.engine/-engine/speculative-connect.md) + +Opens a speculative connection to the host of [url](speculative-connect.md#mozilla.components.browser.engine.gecko.GeckoEngine$speculativeConnect(kotlin.String)/url). + +This is useful if an app thinks it may be making a request to that host in the near future. If no request +is made, the connection will be cleaned up after an unspecified. + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/-init-.md b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/-init-.md new file mode 100644 index 00000000000..6a503a43521 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/-init-.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [NestedGeckoView](index.md) / [<init>](./-init-.md) + +# <init> + +`NestedGeckoView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`)` + +geckoView that supports nested scrolls (for using in a CoordinatorLayout). + +This code is a simplified version of the NestedScrollView implementation +which can be found in the support library: +[android.support.v4.widget.NestedScrollView](#) + +Based on: +https://github.com/takahirom/webview-in-coordinatorlayout + diff --git a/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/dispatch-nested-fling.md b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/dispatch-nested-fling.md new file mode 100644 index 00000000000..482b98c6d91 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/dispatch-nested-fling.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [NestedGeckoView](index.md) / [dispatchNestedFling](./dispatch-nested-fling.md) + +# dispatchNestedFling + +`open fun dispatchNestedFling(velocityX: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`, velocityY: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`, consumed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/NestedGeckoView.kt#L130) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/dispatch-nested-pre-fling.md b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/dispatch-nested-pre-fling.md new file mode 100644 index 00000000000..b3059bafd66 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/dispatch-nested-pre-fling.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [NestedGeckoView](index.md) / [dispatchNestedPreFling](./dispatch-nested-pre-fling.md) + +# dispatchNestedPreFling + +`open fun dispatchNestedPreFling(velocityX: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`, velocityY: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/NestedGeckoView.kt#L134) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/dispatch-nested-pre-scroll.md b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/dispatch-nested-pre-scroll.md new file mode 100644 index 00000000000..eebfdf90b53 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/dispatch-nested-pre-scroll.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [NestedGeckoView](index.md) / [dispatchNestedPreScroll](./dispatch-nested-pre-scroll.md) + +# dispatchNestedPreScroll + +`open fun dispatchNestedPreScroll(dx: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dy: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, consumed: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`?, offsetInWindow: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/NestedGeckoView.kt#L126) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/dispatch-nested-scroll.md b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/dispatch-nested-scroll.md new file mode 100644 index 00000000000..3fbf30b4173 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/dispatch-nested-scroll.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [NestedGeckoView](index.md) / [dispatchNestedScroll](./dispatch-nested-scroll.md) + +# dispatchNestedScroll + +`open fun dispatchNestedScroll(dxConsumed: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dyConsumed: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dxUnconsumed: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dyUnconsumed: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, offsetInWindow: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/NestedGeckoView.kt#L116) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/has-nested-scrolling-parent.md b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/has-nested-scrolling-parent.md new file mode 100644 index 00000000000..4e7e0d839d7 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/has-nested-scrolling-parent.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [NestedGeckoView](index.md) / [hasNestedScrollingParent](./has-nested-scrolling-parent.md) + +# hasNestedScrollingParent + +`open fun hasNestedScrollingParent(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/NestedGeckoView.kt#L112) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/index.md b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/index.md new file mode 100644 index 00000000000..af880fdfa8d --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/index.md @@ -0,0 +1,54 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [NestedGeckoView](./index.md) + +# NestedGeckoView + +`open class NestedGeckoView : `[`GeckoView`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoView.html)`, NestedScrollingChild` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/NestedGeckoView.kt#L27) + +geckoView that supports nested scrolls (for using in a CoordinatorLayout). + +This code is a simplified version of the NestedScrollView implementation +which can be found in the support library: +[android.support.v4.widget.NestedScrollView](#) + +Based on: +https://github.com/takahirom/webview-in-coordinatorlayout + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `NestedGeckoView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`)`
geckoView that supports nested scrolls (for using in a CoordinatorLayout). | + +### Functions + +| Name | Summary | +|---|---| +| [dispatchNestedFling](dispatch-nested-fling.md) | `open fun dispatchNestedFling(velocityX: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`, velocityY: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`, consumed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [dispatchNestedPreFling](dispatch-nested-pre-fling.md) | `open fun dispatchNestedPreFling(velocityX: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`, velocityY: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [dispatchNestedPreScroll](dispatch-nested-pre-scroll.md) | `open fun dispatchNestedPreScroll(dx: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dy: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, consumed: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`?, offsetInWindow: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [dispatchNestedScroll](dispatch-nested-scroll.md) | `open fun dispatchNestedScroll(dxConsumed: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dyConsumed: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dxUnconsumed: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dyUnconsumed: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, offsetInWindow: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [hasNestedScrollingParent](has-nested-scrolling-parent.md) | `open fun hasNestedScrollingParent(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [isNestedScrollingEnabled](is-nested-scrolling-enabled.md) | `open fun isNestedScrollingEnabled(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onTouchEvent](on-touch-event.md) | `open fun onTouchEvent(ev: `[`MotionEvent`](https://developer.android.com/reference/android/view/MotionEvent.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [setNestedScrollingEnabled](set-nested-scrolling-enabled.md) | `open fun setNestedScrollingEnabled(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) | +| [startNestedScroll](start-nested-scroll.md) | `open fun startNestedScroll(axes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [stopNestedScroll](stop-nested-scroll.md) | `open fun stopNestedScroll(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Extension Properties + +| Name | Summary | +|---|---| +| [isLTR](../../mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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? | + +### Extension Functions + +| Name | Summary | +|---|---| +| [forEach](../../mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md) | `fun `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`.forEach(action: (`[`View`](https://developer.android.com/reference/android/view/View.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 the given action on each View in this ViewGroup. | +| [hideKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.hideKeyboard(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Hides the soft input window. | +| [isGone](../../mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [isVisible](../../mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [setPadding](../../mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.setPadding(padding: `[`Padding`](../../mozilla.components.support.base.android/-padding/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Set a padding using [Padding](../../mozilla.components.support.base.android/-padding/index.md) object. | +| [showKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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/mozilla.components.browser.engine.gecko/-nested-gecko-view/is-nested-scrolling-enabled.md b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/is-nested-scrolling-enabled.md new file mode 100644 index 00000000000..c22dcafc451 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/is-nested-scrolling-enabled.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [NestedGeckoView](index.md) / [isNestedScrollingEnabled](./is-nested-scrolling-enabled.md) + +# isNestedScrollingEnabled + +`open fun isNestedScrollingEnabled(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/NestedGeckoView.kt#L100) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/on-touch-event.md b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/on-touch-event.md new file mode 100644 index 00000000000..3b45a967739 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/on-touch-event.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [NestedGeckoView](index.md) / [onTouchEvent](./on-touch-event.md) + +# onTouchEvent + +`open fun onTouchEvent(ev: `[`MotionEvent`](https://developer.android.com/reference/android/view/MotionEvent.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/NestedGeckoView.kt#L48) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/set-nested-scrolling-enabled.md b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/set-nested-scrolling-enabled.md new file mode 100644 index 00000000000..73013f07bfe --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/set-nested-scrolling-enabled.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [NestedGeckoView](index.md) / [setNestedScrollingEnabled](./set-nested-scrolling-enabled.md) + +# setNestedScrollingEnabled + +`open fun setNestedScrollingEnabled(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/NestedGeckoView.kt#L96) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/start-nested-scroll.md b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/start-nested-scroll.md new file mode 100644 index 00000000000..b9c96b00894 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/start-nested-scroll.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [NestedGeckoView](index.md) / [startNestedScroll](./start-nested-scroll.md) + +# startNestedScroll + +`open fun startNestedScroll(axes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/NestedGeckoView.kt#L104) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/stop-nested-scroll.md b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/stop-nested-scroll.md new file mode 100644 index 00000000000..ff03a45cb08 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/-nested-gecko-view/stop-nested-scroll.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.gecko](../index.md) / [NestedGeckoView](index.md) / [stopNestedScroll](./stop-nested-scroll.md) + +# stopNestedScroll + +`open fun stopNestedScroll(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/NestedGeckoView.kt#L108) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.gecko/index.md b/docs/api/mozilla.components.browser.engine.gecko/index.md new file mode 100644 index 00000000000..8cd91beaa66 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.gecko/index.md @@ -0,0 +1,13 @@ +[android-components](../index.md) / [mozilla.components.browser.engine.gecko](./index.md) + +## Package mozilla.components.browser.engine.gecko + +### Types + +| Name | Summary | +|---|---| +| [GeckoEngine](-gecko-engine/index.md) | `class GeckoEngine : `[`Engine`](../mozilla.components.concept.engine/-engine/index.md)
Gecko-based implementation of Engine interface. | +| [GeckoEngineSession](-gecko-engine-session/index.md) | `class GeckoEngineSession : CoroutineScope, `[`EngineSession`](../mozilla.components.concept.engine/-engine-session/index.md)
Gecko-based EngineSession implementation. | +| [GeckoEngineSessionState](-gecko-engine-session-state/index.md) | `class GeckoEngineSessionState : `[`EngineSessionState`](../mozilla.components.concept.engine/-engine-session-state/index.md) | +| [GeckoEngineView](-gecko-engine-view/index.md) | `class GeckoEngineView : `[`FrameLayout`](https://developer.android.com/reference/android/widget/FrameLayout.html)`, `[`EngineView`](../mozilla.components.concept.engine/-engine-view/index.md)
Gecko-based EngineView implementation. | +| [NestedGeckoView](-nested-gecko-view/index.md) | `open class NestedGeckoView : `[`GeckoView`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoView.html)`, NestedScrollingChild`
geckoView that supports nested scrolls (for using in a CoordinatorLayout). | diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session-state/-init-.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session-state/-init-.md new file mode 100644 index 00000000000..1aa181a1d41 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session-state/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSessionState](index.md) / [<init>](./-init-.md) + +# <init> + +`ServoEngineSessionState()` + +No-op implementation of [EngineSessionState](../../mozilla.components.concept.engine/-engine-session-state/index.md). + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session-state/from-j-s-o-n.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session-state/from-j-s-o-n.md new file mode 100644 index 00000000000..88454f95499 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session-state/from-j-s-o-n.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSessionState](index.md) / [fromJSON](./from-j-s-o-n.md) + +# fromJSON + +`fun fromJSON(json: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`ServoEngineSessionState`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSessionState.kt#L17) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session-state/index.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session-state/index.md new file mode 100644 index 00000000000..b909dafbba4 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session-state/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSessionState](./index.md) + +# ServoEngineSessionState + +`class ServoEngineSessionState : `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSessionState.kt#L13) + +No-op implementation of [EngineSessionState](../../mozilla.components.concept.engine/-engine-session-state/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ServoEngineSessionState()`
No-op implementation of [EngineSessionState](../../mozilla.components.concept.engine/-engine-session-state/index.md). | + +### Functions + +| Name | Summary | +|---|---| +| [toJSON](to-j-s-o-n.md) | `fun toJSON(): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)
Create a JSON representation of this state that can be saved to disk. | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [fromJSON](from-j-s-o-n.md) | `fun fromJSON(json: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`ServoEngineSessionState`](./index.md) | diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session-state/to-j-s-o-n.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session-state/to-j-s-o-n.md new file mode 100644 index 00000000000..6920b12858d --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session-state/to-j-s-o-n.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSessionState](index.md) / [toJSON](./to-j-s-o-n.md) + +# toJSON + +`fun toJSON(): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSessionState.kt#L14) + +Overrides [EngineSessionState.toJSON](../../mozilla.components.concept.engine/-engine-session-state/to-j-s-o-n.md) + +Create a JSON representation of this state that can be saved to disk. + +When reading JSON from disk [Engine.createSessionState](#) can be used to turn it back into an [EngineSessionState](../../mozilla.components.concept.engine/-engine-session-state/index.md) +instance. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/-init-.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/-init-.md new file mode 100644 index 00000000000..d102fdbefdd --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [<init>](./-init-.md) + +# <init> + +`ServoEngineSession(defaultSettings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md)`? = null)` + +Servo-based EngineSession implementation. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/capture-thumbnail.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/capture-thumbnail.md new file mode 100644 index 00000000000..428d0933564 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/capture-thumbnail.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [captureThumbnail](./capture-thumbnail.md) + +# captureThumbnail + +`fun captureThumbnail(): `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L147) + +Overrides [EngineSession.captureThumbnail](../../mozilla.components.concept.engine/-engine-session/capture-thumbnail.md) + +Takes a screenshot of the actual tab + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/clear-data.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/clear-data.md new file mode 100644 index 00000000000..8f6f39caf51 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/clear-data.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [clearData](./clear-data.md) + +# clearData + +`fun clearData(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L127) + +Overrides [EngineSession.clearData](../../mozilla.components.concept.engine/-engine-session/clear-data.md) + +Clears all user data sources available. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/clear-find-matches.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/clear-find-matches.md new file mode 100644 index 00000000000..e234a1d5d50 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/clear-find-matches.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [clearFindMatches](./clear-find-matches.md) + +# clearFindMatches + +`fun clearFindMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L139) + +Overrides [EngineSession.clearFindMatches](../../mozilla.components.concept.engine/-engine-session/clear-find-matches.md) + +Clears the highlighted results of previous calls to [findAll](find-all.md) / [findNext](find-next.md). + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/disable-tracking-protection.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/disable-tracking-protection.md new file mode 100644 index 00000000000..559c2d59635 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/disable-tracking-protection.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [disableTrackingProtection](./disable-tracking-protection.md) + +# disableTrackingProtection + +`fun disableTrackingProtection(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L119) + +Overrides [EngineSession.disableTrackingProtection](../../mozilla.components.concept.engine/-engine-session/disable-tracking-protection.md) + +Disables tracking protection for this engine session. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/enable-tracking-protection.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/enable-tracking-protection.md new file mode 100644 index 00000000000..1c2fc181fbe --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/enable-tracking-protection.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [enableTrackingProtection](./enable-tracking-protection.md) + +# enableTrackingProtection + +`fun enableTrackingProtection(policy: `[`TrackingProtectionPolicy`](../../mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L115) + +Overrides [EngineSession.enableTrackingProtection](../../mozilla.components.concept.engine/-engine-session/enable-tracking-protection.md) + +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/mozilla.components.browser.engine.servo/-servo-engine-session/exit-full-screen-mode.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/exit-full-screen-mode.md new file mode 100644 index 00000000000..0a88e7712fc --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/exit-full-screen-mode.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [exitFullScreenMode](./exit-full-screen-mode.md) + +# exitFullScreenMode + +`fun exitFullScreenMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L143) + +Overrides [EngineSession.exitFullScreenMode](../../mozilla.components.concept.engine/-engine-session/exit-full-screen-mode.md) + +Exits fullscreen mode if currently in it that state. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/find-all.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/find-all.md new file mode 100644 index 00000000000..e8862843bb8 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/find-all.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [findAll](./find-all.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L131) + +Overrides [EngineSession.findAll](../../mozilla.components.concept.engine/-engine-session/find-all.md) + +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/mozilla.components.browser.engine.servo/-servo-engine-session/find-next.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/find-next.md new file mode 100644 index 00000000000..efd46121796 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/find-next.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [findNext](./find-next.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L135) + +Overrides [EngineSession.findNext](../../mozilla.components.concept.engine/-engine-session/find-next.md) + +Finds and highlights the next or previous match found by [findAll](find-all.md). + +### 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/mozilla.components.browser.engine.servo/-servo-engine-session/go-back.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/go-back.md new file mode 100644 index 00000000000..8c948f579c3 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/go-back.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [goBack](./go-back.md) + +# goBack + +`fun goBack(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L99) + +Overrides [EngineSession.goBack](../../mozilla.components.concept.engine/-engine-session/go-back.md) + +Navigates back in the history of this session. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/go-forward.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/go-forward.md new file mode 100644 index 00000000000..ad164db205d --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/go-forward.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [goForward](./go-forward.md) + +# goForward + +`fun goForward(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L103) + +Overrides [EngineSession.goForward](../../mozilla.components.concept.engine/-engine-session/go-forward.md) + +Navigates forward in the history of this session. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/index.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/index.md new file mode 100644 index 00000000000..8e0d57f2809 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/index.md @@ -0,0 +1,47 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](./index.md) + +# ServoEngineSession + +`class ServoEngineSession : `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L21) + +Servo-based EngineSession implementation. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ServoEngineSession(defaultSettings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md)`? = null)`
Servo-based EngineSession implementation. | + +### Properties + +| Name | Summary | +|---|---| +| [settings](settings.md) | `val settings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md)
Provides access to the settings of this engine session. | + +### Functions + +| Name | Summary | +|---|---| +| [captureThumbnail](capture-thumbnail.md) | `fun captureThumbnail(): `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?`
Takes a screenshot of the actual tab | +| [clearData](clear-data.md) | `fun clearData(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Clears all user data sources available. | +| [clearFindMatches](clear-find-matches.md) | `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.md) / [findNext](find-next.md). | +| [disableTrackingProtection](disable-tracking-protection.md) | `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.md) | `fun enableTrackingProtection(policy: `[`TrackingProtectionPolicy`](../../mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Enables tracking protection for this engine session. | +| [exitFullScreenMode](exit-full-screen-mode.md) | `fun exitFullScreenMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Exits fullscreen mode if currently in it that state. | +| [findAll](find-all.md) | `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.md) | `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.md). | +| [goBack](go-back.md) | `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.md) | `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.md) | `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)
Loads the data with the given mimeType. Example: | +| [loadUrl](load-url.md) | `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.md) | `fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Reloads the current URL. | +| [restoreState](restore-state.md) | `fun restoreState(state: `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Restores the engine state as provided by [saveState](save-state.md). | +| [saveState](save-state.md) | `fun saveState(): `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md)
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.md) and the specific engine implementation for details. | +| [stopLoading](stop-loading.md) | `fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stops loading the current session. | +| [toggleDesktopMode](toggle-desktop-mode.md) | `fun toggleDesktopMode(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)
Enables/disables Desktop Mode with an optional ability to reload the session right after. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [close](../../mozilla.components.concept.engine/-engine-session/close.md) | `open 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/mozilla.components.browser.engine.servo/-servo-engine-session/load-data.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/load-data.md new file mode 100644 index 00000000000..b557df73f1e --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/load-data.md @@ -0,0 +1,29 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [loadData](./load-data.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L87) + +Overrides [EngineSession.loadData](../../mozilla.components.concept.engine/-engine-session/load-data.md) + +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/mozilla.components.browser.engine.servo/-servo-engine-session/load-url.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/load-url.md new file mode 100644 index 00000000000..77a1791ef02 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/load-url.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [loadUrl](./load-url.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L78) + +Overrides [EngineSession.loadUrl](../../mozilla.components.concept.engine/-engine-session/load-url.md) + +Loads the given URL. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/reload.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/reload.md new file mode 100644 index 00000000000..76d874dc08f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/reload.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [reload](./reload.md) + +# reload + +`fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L95) + +Overrides [EngineSession.reload](../../mozilla.components.concept.engine/-engine-session/reload.md) + +Reloads the current URL. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/restore-state.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/restore-state.md new file mode 100644 index 00000000000..ae264c801aa --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/restore-state.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [restoreState](./restore-state.md) + +# restoreState + +`fun restoreState(state: `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L111) + +Overrides [EngineSession.restoreState](../../mozilla.components.concept.engine/-engine-session/restore-state.md) + +Restores the engine state as provided by [saveState](save-state.md). + +### Parameters + +`state` - state retrieved from [saveState](save-state.md) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/save-state.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/save-state.md new file mode 100644 index 00000000000..cdc85617d8a --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/save-state.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [saveState](./save-state.md) + +# saveState + +`fun saveState(): `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L107) + +Overrides [EngineSession.saveState](../../mozilla.components.concept.engine/-engine-session/save-state.md) + +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.md) and the specific +engine implementation for details. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/settings.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/settings.md new file mode 100644 index 00000000000..d5d101ad2b4 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/settings.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [settings](./settings.md) + +# settings + +`val settings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L24) + +Overrides [EngineSession.settings](../../mozilla.components.concept.engine/-engine-session/settings.md) + +Provides access to the settings of this engine session. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/stop-loading.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/stop-loading.md new file mode 100644 index 00000000000..1c663270bba --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/stop-loading.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [stopLoading](./stop-loading.md) + +# stopLoading + +`fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L91) + +Overrides [EngineSession.stopLoading](../../mozilla.components.concept.engine/-engine-session/stop-loading.md) + +Stops loading the current session. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/toggle-desktop-mode.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/toggle-desktop-mode.md new file mode 100644 index 00000000000..6dd8f27b0ce --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-session/toggle-desktop-mode.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineSession](index.md) / [toggleDesktopMode](./toggle-desktop-mode.md) + +# toggleDesktopMode + +`fun toggleDesktopMode(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineSession.kt#L123) + +Overrides [EngineSession.toggleDesktopMode](../../mozilla.components.concept.engine/-engine-session/toggle-desktop-mode.md) + +Enables/disables Desktop Mode with an optional ability to reload the session right after. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/-init-.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/-init-.md new file mode 100644 index 00000000000..b33d9009830 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineView](index.md) / [<init>](./-init-.md) + +# <init> + +`ServoEngineView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)` + +Servo-based implementation of EngineView. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/index.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/index.md new file mode 100644 index 00000000000..a01c672f1b1 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/index.md @@ -0,0 +1,51 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineView](./index.md) + +# ServoEngineView + +`class ServoEngineView : `[`FrameLayout`](https://developer.android.com/reference/android/widget/FrameLayout.html)`, `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineView.kt#L17) + +Servo-based implementation of EngineView. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ServoEngineView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)`
Servo-based implementation of EngineView. | + +### Functions + +| Name | Summary | +|---|---| +| [onPause](on-pause.md) | `fun onPause(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_PAUSE](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | +| [onResume](on-resume.md) | `fun onResume(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_RESUME](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | +| [render](render.md) | `fun render(session: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Render the content of the given session. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [asView](../../mozilla.components.concept.engine/-engine-view/as-view.md) | `open fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html)
Convenience method to cast the implementation of this interface to an Android View object. | +| [canScrollVerticallyDown](../../mozilla.components.concept.engine/-engine-view/can-scroll-vertically-down.md) | `open fun canScrollVerticallyDown(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Check if [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) can be scrolled vertically down. true if can and false otherwise. | +| [onCreate](../../mozilla.components.concept.engine/-engine-view/on-create.md) | `open fun onCreate(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_CREATE](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | +| [onDestroy](../../mozilla.components.concept.engine/-engine-view/on-destroy.md) | `open fun onDestroy(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_DESTROY](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | +| [onStart](../../mozilla.components.concept.engine/-engine-view/on-start.md) | `open fun onStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_START](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | +| [onStop](../../mozilla.components.concept.engine/-engine-view/on-stop.md) | `open fun onStop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_STOP](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | + +### Extension Properties + +| Name | Summary | +|---|---| +| [isLTR](../../mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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? | + +### Extension Functions + +| Name | Summary | +|---|---| +| [forEach](../../mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md) | `fun `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`.forEach(action: (`[`View`](https://developer.android.com/reference/android/view/View.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 the given action on each View in this ViewGroup. | +| [hideKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.hideKeyboard(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Hides the soft input window. | +| [isGone](../../mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [isVisible](../../mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [setPadding](../../mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.setPadding(padding: `[`Padding`](../../mozilla.components.support.base.android/-padding/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Set a padding using [Padding](../../mozilla.components.support.base.android/-padding/index.md) object. | +| [showKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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/mozilla.components.browser.engine.servo/-servo-engine-view/on-pause.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/on-pause.md new file mode 100644 index 00000000000..264a9cf4251 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/on-pause.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineView](index.md) / [onPause](./on-pause.md) + +# onPause + +`fun onPause(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineView.kt#L41) + +Overrides [EngineView.onPause](../../mozilla.components.concept.engine/-engine-view/on-pause.md) + +To be called in response to [Lifecycle.Event.ON_PAUSE](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) +implementations for details. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/on-resume.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/on-resume.md new file mode 100644 index 00000000000..e5ef31efb7f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/on-resume.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineView](index.md) / [onResume](./on-resume.md) + +# onResume + +`fun onResume(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineView.kt#L35) + +Overrides [EngineView.onResume](../../mozilla.components.concept.engine/-engine-view/on-resume.md) + +To be called in response to [Lifecycle.Event.ON_RESUME](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) +implementations for details. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/render.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/render.md new file mode 100644 index 00000000000..1ce116326fa --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine-view/render.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngineView](index.md) / [render](./render.md) + +# render + +`fun render(session: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngineView.kt#L27) + +Overrides [EngineView.render](../../mozilla.components.concept.engine/-engine-view/render.md) + +Render the content of the given session. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine/-init-.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine/-init-.md new file mode 100644 index 00000000000..7dd015e5672 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngine](index.md) / [<init>](./-init-.md) + +# <init> + +`ServoEngine(defaultSettings: `[`DefaultSettings`](../../mozilla.components.concept.engine/-default-settings/index.md)` = DefaultSettings())` + +Servo-based implementation of the Engine interface. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine/create-session-state.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine/create-session-state.md new file mode 100644 index 00000000000..b10a5837729 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine/create-session-state.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngine](index.md) / [createSessionState](./create-session-state.md) + +# createSessionState + +`fun createSessionState(json: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngine.kt#L32) + +Overrides [Engine.createSessionState](../../mozilla.components.concept.engine/-engine/create-session-state.md) + +Create a new [EngineSessionState](../../mozilla.components.concept.engine/-engine-session-state/index.md) instance from the serialized JSON representation. + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine/create-session.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine/create-session.md new file mode 100644 index 00000000000..8674e327508 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine/create-session.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngine](index.md) / [createSession](./create-session.md) + +# createSession + +`fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngine.kt#L28) + +Overrides [Engine.createSession](../../mozilla.components.concept.engine/-engine/create-session.md) + +Creates a new engine session. + +### Parameters + +`private` - whether or not this session should use private mode. + +**Return** +the newly created [EngineSession](../../mozilla.components.concept.engine/-engine-session/index.md). + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine/create-view.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine/create-view.md new file mode 100644 index 00000000000..f9541523200 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine/create-view.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngine](index.md) / [createView](./create-view.md) + +# createView + +`fun createView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`?): `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngine.kt#L24) + +Overrides [Engine.createView](../../mozilla.components.concept.engine/-engine/create-view.md) + +Creates a new view for rendering web content. + +### Parameters + +`context` - an application context + +`attrs` - optional set of attributes + +**Return** +new newly created [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md). + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine/index.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine/index.md new file mode 100644 index 00000000000..b5020ce2ab6 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine/index.md @@ -0,0 +1,29 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngine](./index.md) + +# ServoEngine + +`class ServoEngine : `[`Engine`](../../mozilla.components.concept.engine/-engine/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngine.kt#L21) + +Servo-based implementation of the Engine interface. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ServoEngine(defaultSettings: `[`DefaultSettings`](../../mozilla.components.concept.engine/-default-settings/index.md)` = DefaultSettings())`
Servo-based implementation of the Engine interface. | + +### Properties + +| Name | Summary | +|---|---| +| [settings](settings.md) | `val settings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md)
See [Engine.settings](../../mozilla.components.concept.engine/-engine/settings.md) | + +### Functions + +| Name | Summary | +|---|---| +| [createSession](create-session.md) | `fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)
Creates a new engine session. | +| [createSessionState](create-session-state.md) | `fun createSessionState(json: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md)
Create a new [EngineSessionState](../../mozilla.components.concept.engine/-engine-session-state/index.md) instance from the serialized JSON representation. | +| [createView](create-view.md) | `fun createView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`?): `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md)
Creates a new view for rendering web content. | +| [name](name.md) | `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. | +| [speculativeConnect](speculative-connect.md) | `fun speculativeConnect(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)
Opens a speculative connection to the host of [url](speculative-connect.md#mozilla.components.browser.engine.servo.ServoEngine$speculativeConnect(kotlin.String)/url). | diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine/name.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine/name.md new file mode 100644 index 00000000000..9798766cbf0 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine/name.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngine](index.md) / [name](./name.md) + +# name + +`fun name(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngine.kt#L43) + +Overrides [Engine.name](../../mozilla.components.concept.engine/-engine/name.md) + +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/mozilla.components.browser.engine.servo/-servo-engine/settings.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine/settings.md new file mode 100644 index 00000000000..509a69f6120 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine/settings.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngine](index.md) / [settings](./settings.md) + +# settings + +`val settings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngine.kt#L48) + +Overrides [Engine.settings](../../mozilla.components.concept.engine/-engine/settings.md) + +See [Engine.settings](../../mozilla.components.concept.engine/-engine/settings.md) + diff --git a/docs/api/mozilla.components.browser.engine.servo/-servo-engine/speculative-connect.md b/docs/api/mozilla.components.browser.engine.servo/-servo-engine/speculative-connect.md new file mode 100644 index 00000000000..d925dd93f6d --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/-servo-engine/speculative-connect.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.servo](../index.md) / [ServoEngine](index.md) / [speculativeConnect](./speculative-connect.md) + +# speculativeConnect + +`fun speculativeConnect(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-servo/src/main/java/mozilla/components/browser/engine/servo/ServoEngine.kt#L41) + +Overrides [Engine.speculativeConnect](../../mozilla.components.concept.engine/-engine/speculative-connect.md) + +Opens a speculative connection to the host of [url](speculative-connect.md#mozilla.components.browser.engine.servo.ServoEngine$speculativeConnect(kotlin.String)/url). + +Note: This implementation is a no-op. + diff --git a/docs/api/mozilla.components.browser.engine.servo/index.md b/docs/api/mozilla.components.browser.engine.servo/index.md new file mode 100644 index 00000000000..377d4dc976d --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.servo/index.md @@ -0,0 +1,12 @@ +[android-components](../index.md) / [mozilla.components.browser.engine.servo](./index.md) + +## Package mozilla.components.browser.engine.servo + +### Types + +| Name | Summary | +|---|---| +| [ServoEngine](-servo-engine/index.md) | `class ServoEngine : `[`Engine`](../mozilla.components.concept.engine/-engine/index.md)
Servo-based implementation of the Engine interface. | +| [ServoEngineSession](-servo-engine-session/index.md) | `class ServoEngineSession : `[`EngineSession`](../mozilla.components.concept.engine/-engine-session/index.md)
Servo-based EngineSession implementation. | +| [ServoEngineSessionState](-servo-engine-session-state/index.md) | `class ServoEngineSessionState : `[`EngineSessionState`](../mozilla.components.concept.engine/-engine-session-state/index.md)
No-op implementation of [EngineSessionState](../mozilla.components.concept.engine/-engine-session-state/index.md). | +| [ServoEngineView](-servo-engine-view/index.md) | `class ServoEngineView : `[`FrameLayout`](https://developer.android.com/reference/android/widget/FrameLayout.html)`, `[`EngineView`](../mozilla.components.concept.engine/-engine-view/index.md)
Servo-based implementation of EngineView. | diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/char-at.md b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/char-at.md new file mode 100644 index 00000000000..438142f9bb7 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/char-at.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [ReversibleString](index.md) / [charAt](./char-at.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/ReversibleString.kt#L20) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/create.md b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/create.md new file mode 100644 index 00000000000..31e1b86af18 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/create.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [ReversibleString](index.md) / [create](./create.md) + +# create + +`fun create(string: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`ReversibleString`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/ReversibleString.kt#L82) + +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/mozilla.components.browser.engine.system.matcher/-reversible-string/index.md b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/index.md new file mode 100644 index 00000000000..d52436b8ab4 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/index.md @@ -0,0 +1,35 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [ReversibleString](./index.md) + +# ReversibleString + +`abstract class ReversibleString` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/ReversibleString.kt#L14) + +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 + +| Name | Summary | +|---|---| +| [isReversed](is-reversed.md) | `abstract val isReversed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [offsetEnd](offset-end.md) | `val offsetEnd: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [offsetStart](offset-start.md) | `val offsetStart: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [string](string.md) | `val string: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [charAt](char-at.md) | `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.md) | `fun length(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns the length of this string. | +| [reverse](reverse.md) | `fun reverse(): `[`ReversibleString`](./index.md)
Reverses this string. | +| [substring](substring.md) | `abstract fun substring(startIndex: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`ReversibleString`](./index.md) | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [create](create.md) | `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/mozilla.components.browser.engine.system.matcher/-reversible-string/is-reversed.md b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/is-reversed.md new file mode 100644 index 00000000000..b34a0c8d40f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/is-reversed.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [ReversibleString](index.md) / [isReversed](./is-reversed.md) + +# isReversed + +`abstract val isReversed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/ReversibleString.kt#L19) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/length.md b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/length.md new file mode 100644 index 00000000000..7be47dbcbe5 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/length.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [ReversibleString](index.md) / [length](./length.md) + +# length + +`fun length(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/ReversibleString.kt#L32) + +Returns the length of this string. + diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/offset-end.md b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/offset-end.md new file mode 100644 index 00000000000..907d0268e8b --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/offset-end.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [ReversibleString](index.md) / [offsetEnd](./offset-end.md) + +# offsetEnd + +`protected val offsetEnd: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/ReversibleString.kt#L17) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/offset-start.md b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/offset-start.md new file mode 100644 index 00000000000..d34c059150c --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/offset-start.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [ReversibleString](index.md) / [offsetStart](./offset-start.md) + +# offsetStart + +`protected val offsetStart: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/ReversibleString.kt#L16) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/reverse.md b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/reverse.md new file mode 100644 index 00000000000..0ef32f1290e --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/reverse.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [ReversibleString](index.md) / [reverse](./reverse.md) + +# reverse + +`fun reverse(): `[`ReversibleString`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/ReversibleString.kt#L37) + +Reverses this string. + diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/string.md b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/string.md new file mode 100644 index 00000000000..2249849f9a2 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/string.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [ReversibleString](index.md) / [string](./string.md) + +# string + +`protected val string: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/ReversibleString.kt#L15) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/substring.md b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/substring.md new file mode 100644 index 00000000000..fc7860e8b15 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-reversible-string/substring.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [ReversibleString](index.md) / [substring](./substring.md) + +# substring + +`abstract fun substring(startIndex: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`ReversibleString`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/ReversibleString.kt#L21) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-trie/-init-.md b/docs/api/mozilla.components.browser.engine.system.matcher/-trie/-init-.md new file mode 100644 index 00000000000..085feae11bf --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-trie/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [Trie](index.md) / [<init>](./-init-.md) + +# <init> + +`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. + diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-trie/children.md b/docs/api/mozilla.components.browser.engine.system.matcher/-trie/children.md new file mode 100644 index 00000000000..564438c589c --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-trie/children.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [Trie](index.md) / [children](./children.md) + +# children + +`val children: `[`SparseArray`](https://developer.android.com/reference/android/util/SparseArray.html)`<`[`Trie`](index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/Trie.kt#L13) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-trie/create-node.md b/docs/api/mozilla.components.browser.engine.system.matcher/-trie/create-node.md new file mode 100644 index 00000000000..68dabe4e739 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-trie/create-node.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [Trie](index.md) / [createNode](./create-node.md) + +# createNode + +`open fun createNode(character: `[`Char`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html)`, parent: `[`Trie`](index.md)`): `[`Trie`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/Trie.kt#L102) + +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/mozilla.components.browser.engine.system.matcher/-trie/create-root-node.md b/docs/api/mozilla.components.browser.engine.system.matcher/-trie/create-root-node.md new file mode 100644 index 00000000000..32b492a9d8f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-trie/create-root-node.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [Trie](index.md) / [createRootNode](./create-root-node.md) + +# createRootNode + +`fun createRootNode(): `[`Trie`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/Trie.kt#L110) + +Creates a new root node. + diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-trie/find-node.md b/docs/api/mozilla.components.browser.engine.system.matcher/-trie/find-node.md new file mode 100644 index 00000000000..0dc4954da04 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-trie/find-node.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [Trie](index.md) / [findNode](./find-node.md) + +# findNode + +`fun findNode(string: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Trie`](index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/Trie.kt#L26) +`fun findNode(string: `[`ReversibleString`](../-reversible-string/index.md)`): `[`Trie`](index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/Trie.kt#L36) + +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/mozilla.components.browser.engine.system.matcher/-trie/index.md b/docs/api/mozilla.components.browser.engine.system.matcher/-trie/index.md new file mode 100644 index 00000000000..610c358a3e8 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-trie/index.md @@ -0,0 +1,33 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [Trie](./index.md) + +# Trie + +`open class Trie` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/Trie.kt#L12) + +Simple implementation of a Trie, used for indexing URLs. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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 + +| Name | Summary | +|---|---| +| [children](children.md) | `val children: `[`SparseArray`](https://developer.android.com/reference/android/util/SparseArray.html)`<`[`Trie`](./index.md)`>` | + +### Functions + +| Name | Summary | +|---|---| +| [createNode](create-node.md) | `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.md) | `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.md)`): `[`Trie`](./index.md)`?`
Finds the node corresponding to the provided string. | +| [put](put.md) | `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.md)`): `[`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 + +| Name | Summary | +|---|---| +| [createRootNode](create-root-node.md) | `fun createRootNode(): `[`Trie`](./index.md)
Creates a new root node. | diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-trie/put.md b/docs/api/mozilla.components.browser.engine.system.matcher/-trie/put.md new file mode 100644 index 00000000000..ff54f633e83 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-trie/put.md @@ -0,0 +1,27 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [Trie](index.md) / [put](./put.md) + +# put + +`fun put(string: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Trie`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/Trie.kt#L57) +`fun put(string: `[`ReversibleString`](../-reversible-string/index.md)`): `[`Trie`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/Trie.kt#L67) + +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.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/Trie.kt#L84) + +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/mozilla.components.browser.engine.system.matcher/-url-matcher/-a-d-v-e-r-t-i-s-i-n-g.md b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-a-d-v-e-r-t-i-s-i-n-g.md new file mode 100644 index 00000000000..eb4ca54ff22 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-a-d-v-e-r-t-i-s-i-n-g.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [UrlMatcher](index.md) / [ADVERTISING](./-a-d-v-e-r-t-i-s-i-n-g.md) + +# ADVERTISING + +`const val ADVERTISING: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/UrlMatcher.kt#L139) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-a-n-a-l-y-t-i-c-s.md b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-a-n-a-l-y-t-i-c-s.md new file mode 100644 index 00000000000..179b93697df --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-a-n-a-l-y-t-i-c-s.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [UrlMatcher](index.md) / [ANALYTICS](./-a-n-a-l-y-t-i-c-s.md) + +# ANALYTICS + +`const val ANALYTICS: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/UrlMatcher.kt#L140) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-c-o-n-t-e-n-t.md b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-c-o-n-t-e-n-t.md new file mode 100644 index 00000000000..4780133cfc6 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-c-o-n-t-e-n-t.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [UrlMatcher](index.md) / [CONTENT](./-c-o-n-t-e-n-t.md) + +# CONTENT + +`const val CONTENT: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/UrlMatcher.kt#L141) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-d-e-f-a-u-l-t.md b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-d-e-f-a-u-l-t.md new file mode 100644 index 00000000000..4418141b5d8 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-d-e-f-a-u-l-t.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [UrlMatcher](index.md) / [DEFAULT](./-d-e-f-a-u-l-t.md) + +# DEFAULT + +`const val DEFAULT: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/UrlMatcher.kt#L144) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-d-i-s-c-o-n-n-e-c-t.md b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-d-i-s-c-o-n-n-e-c-t.md new file mode 100644 index 00000000000..3a6932e7fb0 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-d-i-s-c-o-n-n-e-c-t.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [UrlMatcher](index.md) / [DISCONNECT](./-d-i-s-c-o-n-n-e-c-t.md) + +# DISCONNECT + +`const val DISCONNECT: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/UrlMatcher.kt#L142) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-init-.md b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-init-.md new file mode 100644 index 00000000000..8541dc0b00b --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [UrlMatcher](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.browser.engine.system.matcher/-url-matcher/-s-o-c-i-a-l.md b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-s-o-c-i-a-l.md new file mode 100644 index 00000000000..67d14ad5822 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/-s-o-c-i-a-l.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [UrlMatcher](index.md) / [SOCIAL](./-s-o-c-i-a-l.md) + +# SOCIAL + +`const val SOCIAL: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/UrlMatcher.kt#L143) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/create-matcher.md b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/create-matcher.md new file mode 100644 index 00000000000..727d3a6550d --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/create-matcher.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [UrlMatcher](index.md) / [createMatcher](./create-matcher.md) + +# createMatcher + +`fun createMatcher(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, 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)`, enabledCategories: `[`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)`> = supportedCategories): `[`UrlMatcher`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/UrlMatcher.kt#L158) + +Creates a new matcher instance for the provided URL lists. + +### Parameters + +`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(black: `[`Reader`](https://developer.android.com/reference/java/io/Reader.html)`, overrides: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Reader`](https://developer.android.com/reference/java/io/Reader.html)`>?, white: `[`Reader`](https://developer.android.com/reference/java/io/Reader.html)`, enabledCategories: `[`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)`> = supportedCategories): `[`UrlMatcher`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/UrlMatcher.kt#L178) + +Creates a new matcher instance for the provided URL lists. + +### Parameters + +`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/mozilla.components.browser.engine.system.matcher/-url-matcher/index.md b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/index.md new file mode 100644 index 00000000000..0b61ff209e0 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/index.md @@ -0,0 +1,39 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [UrlMatcher](./index.md) + +# UrlMatcher + +`class UrlMatcher` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/UrlMatcher.kt#L19) + +Provides functionality to process categorized URL black/white lists and match +URLs against these lists. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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 + +| Name | Summary | +|---|---| +| [matches](matches.md) | `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`](https://developer.android.com/reference/android/net/Uri.html)`, pageURI: `[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`): `[`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. | +| [setCategoriesEnabled](set-categories-enabled.md) | `fun setCategoriesEnabled(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)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Enables the provided categories. | + +### Companion Object Properties + +| Name | Summary | +|---|---| +| [ADVERTISING](-a-d-v-e-r-t-i-s-i-n-g.md) | `const val ADVERTISING: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ANALYTICS](-a-n-a-l-y-t-i-c-s.md) | `const val ANALYTICS: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [CONTENT](-c-o-n-t-e-n-t.md) | `const val CONTENT: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [DEFAULT](-d-e-f-a-u-l-t.md) | `const val DEFAULT: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [DISCONNECT](-d-i-s-c-o-n-n-e-c-t.md) | `const val DISCONNECT: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [SOCIAL](-s-o-c-i-a-l.md) | `const val SOCIAL: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [createMatcher](create-matcher.md) | `fun createMatcher(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, 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)`, enabledCategories: `[`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)`> = supportedCategories): `[`UrlMatcher`](./index.md)
`fun createMatcher(black: `[`Reader`](https://developer.android.com/reference/java/io/Reader.html)`, overrides: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Reader`](https://developer.android.com/reference/java/io/Reader.html)`>?, white: `[`Reader`](https://developer.android.com/reference/java/io/Reader.html)`, enabledCategories: `[`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)`> = supportedCategories): `[`UrlMatcher`](./index.md)
Creates a new matcher instance for the provided URL lists. | +| [isWebFont](is-web-font.md) | `fun isWebFont(uri: `[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Checks if the given URI points to a Web font. | diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/is-web-font.md b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/is-web-font.md new file mode 100644 index 00000000000..d4e0bb2dc9c --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/is-web-font.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [UrlMatcher](index.md) / [isWebFont](./is-web-font.md) + +# isWebFont + +`fun isWebFont(uri: `[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/UrlMatcher.kt#L207) + +Checks if the given URI points to a Web font. + +### Parameters + +`uri` - the URI to check. + +**Return** +true if the URI is a Web font, otherwise false. + diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/matches.md b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/matches.md new file mode 100644 index 00000000000..29540382c50 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/matches.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [UrlMatcher](index.md) / [matches](./matches.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/UrlMatcher.kt#L93) +`fun matches(resourceURI: `[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`, pageURI: `[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/UrlMatcher.kt#L106) + +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/mozilla.components.browser.engine.system.matcher/-url-matcher/set-categories-enabled.md b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/set-categories-enabled.md new file mode 100644 index 00000000000..7243f30d472 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/-url-matcher/set-categories-enabled.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [UrlMatcher](index.md) / [setCategoriesEnabled](./set-categories-enabled.md) + +# setCategoriesEnabled + +`fun setCategoriesEnabled(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)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/UrlMatcher.kt#L60) + +Enables the provided categories. + +### Parameters + +`categories` - set of categories to enable. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/index.md b/docs/api/mozilla.components.browser.engine.system.matcher/index.md new file mode 100644 index 00000000000..268c46d3cfc --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/index.md @@ -0,0 +1,17 @@ +[android-components](../index.md) / [mozilla.components.browser.engine.system.matcher](./index.md) + +## Package mozilla.components.browser.engine.system.matcher + +### Types + +| Name | Summary | +|---|---| +| [ReversibleString](-reversible-string/index.md) | `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.md) | `open class Trie`
Simple implementation of a Trie, used for indexing URLs. | +| [UrlMatcher](-url-matcher/index.md) | `class UrlMatcher`
Provides functionality to process categorized URL black/white lists and match URLs against these lists. | + +### Extensions for External Classes + +| Name | Summary | +|---|---| +| [kotlin.String](kotlin.-string/index.md) | | diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/kotlin.-string/index.md b/docs/api/mozilla.components.browser.engine.system.matcher/kotlin.-string/index.md new file mode 100644 index 00000000000..1ed2b1145d7 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/kotlin.-string/index.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [kotlin.String](./index.md) + +### Extensions for kotlin.String + +| Name | Summary | +|---|---| +| [reverse](reverse.md) | `fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.reverse(): `[`ReversibleString`](../-reversible-string/index.md) | +| [reversible](reversible.md) | `fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.reversible(): `[`ReversibleString`](../-reversible-string/index.md) | diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/kotlin.-string/reverse.md b/docs/api/mozilla.components.browser.engine.system.matcher/kotlin.-string/reverse.md new file mode 100644 index 00000000000..5d33156db7d --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/kotlin.-string/reverse.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [kotlin.String](index.md) / [reverse](./reverse.md) + +# reverse + +`fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.reverse(): `[`ReversibleString`](../-reversible-string/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/ReversibleString.kt#L92) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.matcher/kotlin.-string/reversible.md b/docs/api/mozilla.components.browser.engine.system.matcher/kotlin.-string/reversible.md new file mode 100644 index 00000000000..0a495c72351 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.matcher/kotlin.-string/reversible.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.matcher](../index.md) / [kotlin.String](index.md) / [reversible](./reversible.md) + +# reversible + +`fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.reversible(): `[`ReversibleString`](../-reversible-string/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/matcher/ReversibleString.kt#L88) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/-init-.md b/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/-init-.md new file mode 100644 index 00000000000..22a0714ce29 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.permission](../index.md) / [SystemPermissionRequest](index.md) / [<init>](./-init-.md) + +# <init> + +`SystemPermissionRequest(nativeRequest: `[`PermissionRequest`](https://developer.android.com/reference/android/webkit/PermissionRequest.html)`)` + +WebView-based implementation of [PermissionRequest](../../mozilla.components.concept.engine.permission/-permission-request/index.md). + diff --git a/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/grant.md b/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/grant.md new file mode 100644 index 00000000000..b28ac0f580f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/grant.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.permission](../index.md) / [SystemPermissionRequest](index.md) / [grant](./grant.md) + +# grant + +`fun grant(permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../../mozilla.components.concept.engine.permission/-permission/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/permission/SystemPermissionRequest.kt#L25) + +Overrides [PermissionRequest.grant](../../mozilla.components.concept.engine.permission/-permission-request/grant.md) + +Grants the provided permissions, or all requested permissions, if none +are provided. + +### Parameters + +`permissions` - the permissions to grant. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/index.md b/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/index.md new file mode 100644 index 00000000000..41a5077cd14 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/index.md @@ -0,0 +1,40 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.permission](../index.md) / [SystemPermissionRequest](./index.md) + +# SystemPermissionRequest + +`class SystemPermissionRequest : `[`PermissionRequest`](../../mozilla.components.concept.engine.permission/-permission-request/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/permission/SystemPermissionRequest.kt#L18) + +WebView-based implementation of [PermissionRequest](../../mozilla.components.concept.engine.permission/-permission-request/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SystemPermissionRequest(nativeRequest: `[`PermissionRequest`](https://developer.android.com/reference/android/webkit/PermissionRequest.html)`)`
WebView-based implementation of [PermissionRequest](../../mozilla.components.concept.engine.permission/-permission-request/index.md). | + +### Properties + +| Name | Summary | +|---|---| +| [permissions](permissions.md) | `val permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../../mozilla.components.concept.engine.permission/-permission/index.md)`>`
List of requested permissions. | +| [uri](uri.md) | `val uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The origin URI which caused the permissions to be requested. | + +### Functions + +| Name | Summary | +|---|---| +| [grant](grant.md) | `fun grant(permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../../mozilla.components.concept.engine.permission/-permission/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Grants the provided permissions, or all requested permissions, if none are provided. | +| [reject](reject.md) | `fun reject(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Rejects the requested permissions. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [containsVideoAndAudioSources](../../mozilla.components.concept.engine.permission/-permission-request/contains-video-and-audio-sources.md) | `open fun containsVideoAndAudioSources(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [grantIf](../../mozilla.components.concept.engine.permission/-permission-request/grant-if.md) | `open fun grantIf(predicate: (`[`Permission`](../../mozilla.components.concept.engine.permission/-permission/index.md)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Grants this permission request if the provided predicate is true for any of the requested permissions. | + +### Companion Object Properties + +| Name | Summary | +|---|---| +| [permissionsMap](permissions-map.md) | `val permissionsMap: `[`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)`, `[`Permission`](../../mozilla.components.concept.engine.permission/-permission/index.md)`>` | diff --git a/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/permissions-map.md b/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/permissions-map.md new file mode 100644 index 00000000000..7134c6253b0 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/permissions-map.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.permission](../index.md) / [SystemPermissionRequest](index.md) / [permissionsMap](./permissions-map.md) + +# permissionsMap + +`val permissionsMap: `[`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)`, `[`Permission`](../../mozilla.components.concept.engine.permission/-permission/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/permission/SystemPermissionRequest.kt#L34) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/permissions.md b/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/permissions.md new file mode 100644 index 00000000000..6938051370f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/permissions.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.permission](../index.md) / [SystemPermissionRequest](index.md) / [permissions](./permissions.md) + +# permissions + +`val permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../../mozilla.components.concept.engine.permission/-permission/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/permission/SystemPermissionRequest.kt#L21) + +Overrides [PermissionRequest.permissions](../../mozilla.components.concept.engine.permission/-permission-request/permissions.md) + +List of requested permissions. + diff --git a/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/reject.md b/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/reject.md new file mode 100644 index 00000000000..c176e6fb44c --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/reject.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.permission](../index.md) / [SystemPermissionRequest](index.md) / [reject](./reject.md) + +# reject + +`fun reject(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/permission/SystemPermissionRequest.kt#L29) + +Overrides [PermissionRequest.reject](../../mozilla.components.concept.engine.permission/-permission-request/reject.md) + +Rejects the requested permissions. + diff --git a/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/uri.md b/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/uri.md new file mode 100644 index 00000000000..a82e070e1ac --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.permission/-system-permission-request/uri.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.permission](../index.md) / [SystemPermissionRequest](index.md) / [uri](./uri.md) + +# uri + +`val uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/permission/SystemPermissionRequest.kt#L19) + +Overrides [PermissionRequest.uri](../../mozilla.components.concept.engine.permission/-permission-request/uri.md) + +The origin URI which caused the permissions to be requested. + diff --git a/docs/api/mozilla.components.browser.engine.system.permission/index.md b/docs/api/mozilla.components.browser.engine.system.permission/index.md new file mode 100644 index 00000000000..541a4535601 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.permission/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.browser.engine.system.permission](./index.md) + +## Package mozilla.components.browser.engine.system.permission + +### Types + +| Name | Summary | +|---|---| +| [SystemPermissionRequest](-system-permission-request/index.md) | `class SystemPermissionRequest : `[`PermissionRequest`](../mozilla.components.concept.engine.permission/-permission-request/index.md)
WebView-based implementation of [PermissionRequest](../mozilla.components.concept.engine.permission/-permission-request/index.md). | diff --git a/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/-init-.md b/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/-init-.md new file mode 100644 index 00000000000..2248737ec89 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.window](../index.md) / [SystemWindowRequest](index.md) / [<init>](./-init-.md) + +# <init> + +`SystemWindowRequest(webView: `[`WebView`](https://developer.android.com/reference/android/webkit/WebView.html)`, newWebView: `[`WebView`](https://developer.android.com/reference/android/webkit/WebView.html)`? = null, openAsDialog: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, triggeredByUser: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, resultMsg: `[`Message`](https://developer.android.com/reference/android/os/Message.html)`? = null)` + +WebView-based implementation of [WindowRequest](../../mozilla.components.concept.engine.window/-window-request/index.md). + diff --git a/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/index.md b/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/index.md new file mode 100644 index 00000000000..f9cded5963a --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/index.md @@ -0,0 +1,28 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.window](../index.md) / [SystemWindowRequest](./index.md) + +# SystemWindowRequest + +`class SystemWindowRequest : `[`WindowRequest`](../../mozilla.components.concept.engine.window/-window-request/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/window/SystemWindowRequest.kt#L22) + +WebView-based implementation of [WindowRequest](../../mozilla.components.concept.engine.window/-window-request/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SystemWindowRequest(webView: `[`WebView`](https://developer.android.com/reference/android/webkit/WebView.html)`, newWebView: `[`WebView`](https://developer.android.com/reference/android/webkit/WebView.html)`? = null, openAsDialog: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, triggeredByUser: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, resultMsg: `[`Message`](https://developer.android.com/reference/android/os/Message.html)`? = null)`
WebView-based implementation of [WindowRequest](../../mozilla.components.concept.engine.window/-window-request/index.md). | + +### Properties + +| Name | Summary | +|---|---| +| [openAsDialog](open-as-dialog.md) | `val openAsDialog: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
whether or not the window should be opened as a dialog, defaults to false. | +| [triggeredByUser](triggered-by-user.md) | `val triggeredByUser: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
whether or not the request was triggered by the user, defaults to false. | +| [url](url.md) | `val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The URL which should be opened in a new window. May be empty if the request was created from JavaScript (using window.open()). | + +### Functions + +| Name | Summary | +|---|---| +| [prepare](prepare.md) | `fun prepare(engineSession: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Prepares the provided [EngineSession](../../mozilla.components.concept.engine/-engine-session/index.md) for the window request. This is used to attach state (e.g. a native session) to the engine session. | +| [start](start.md) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts the window request. | diff --git a/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/open-as-dialog.md b/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/open-as-dialog.md new file mode 100644 index 00000000000..9f235c19916 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/open-as-dialog.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.window](../index.md) / [SystemWindowRequest](index.md) / [openAsDialog](./open-as-dialog.md) + +# openAsDialog + +`val openAsDialog: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/window/SystemWindowRequest.kt#L25) + +whether or not the window should be opened as a dialog, defaults to false. + +### Property + +`openAsDialog` - whether or not the window should be opened as a dialog, defaults to false. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/prepare.md b/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/prepare.md new file mode 100644 index 00000000000..068138a5c02 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/prepare.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.window](../index.md) / [SystemWindowRequest](index.md) / [prepare](./prepare.md) + +# prepare + +`fun prepare(engineSession: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/window/SystemWindowRequest.kt#L32) + +Overrides [WindowRequest.prepare](../../mozilla.components.concept.engine.window/-window-request/prepare.md) + +Prepares the provided [EngineSession](../../mozilla.components.concept.engine/-engine-session/index.md) for the window request. This +is used to attach state (e.g. a native session) to the engine session. + +### Parameters + +`engineSession` - the engine session to prepare. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/start.md b/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/start.md new file mode 100644 index 00000000000..c98fda92829 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/start.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.window](../index.md) / [SystemWindowRequest](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/window/SystemWindowRequest.kt#L38) + +Overrides [WindowRequest.start](../../mozilla.components.concept.engine.window/-window-request/start.md) + +Starts the window request. + diff --git a/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/triggered-by-user.md b/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/triggered-by-user.md new file mode 100644 index 00000000000..8f9b212a560 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/triggered-by-user.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.window](../index.md) / [SystemWindowRequest](index.md) / [triggeredByUser](./triggered-by-user.md) + +# triggeredByUser + +`val triggeredByUser: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/window/SystemWindowRequest.kt#L26) + +whether or not the request was triggered by the user, defaults to false. + +### Property + +`triggeredByUser` - whether or not the request was triggered by the user, defaults to false. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/url.md b/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/url.md new file mode 100644 index 00000000000..3b9f476c684 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.window/-system-window-request/url.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system.window](../index.md) / [SystemWindowRequest](index.md) / [url](./url.md) + +# url + +`val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/window/SystemWindowRequest.kt#L30) + +Overrides [WindowRequest.url](../../mozilla.components.concept.engine.window/-window-request/url.md) + +The URL which should be opened in a new window. May be +empty if the request was created from JavaScript (using +window.open()). + diff --git a/docs/api/mozilla.components.browser.engine.system.window/index.md b/docs/api/mozilla.components.browser.engine.system.window/index.md new file mode 100644 index 00000000000..b3b6bde1c35 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system.window/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.browser.engine.system.window](./index.md) + +## Package mozilla.components.browser.engine.system.window + +### Types + +| Name | Summary | +|---|---| +| [SystemWindowRequest](-system-window-request/index.md) | `class SystemWindowRequest : `[`WindowRequest`](../mozilla.components.concept.engine.window/-window-request/index.md)
WebView-based implementation of [WindowRequest](../mozilla.components.concept.engine.window/-window-request/index.md). | diff --git a/docs/api/mozilla.components.browser.engine.system/-nested-web-view/-init-.md b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/-init-.md new file mode 100644 index 00000000000..ebb751bf175 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/-init-.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [NestedWebView](index.md) / [<init>](./-init-.md) + +# <init> + +`NestedWebView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`)` + +WebView that supports nested scrolls (for using in a CoordinatorLayout). + +This code is a simplified version of the NestedScrollView implementation +which can be found in the support library: +[android.support.v4.widget.NestedScrollView](#) + +Based on: +https://github.com/takahirom/webview-in-coordinatorlayout + diff --git a/docs/api/mozilla.components.browser.engine.system/-nested-web-view/dispatch-nested-fling.md b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/dispatch-nested-fling.md new file mode 100644 index 00000000000..c730cf03a7f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/dispatch-nested-fling.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [NestedWebView](index.md) / [dispatchNestedFling](./dispatch-nested-fling.md) + +# dispatchNestedFling + +`fun dispatchNestedFling(velocityX: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`, velocityY: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`, consumed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/NestedWebView.kt#L136) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-nested-web-view/dispatch-nested-pre-fling.md b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/dispatch-nested-pre-fling.md new file mode 100644 index 00000000000..8bb0a04d8d6 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/dispatch-nested-pre-fling.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [NestedWebView](index.md) / [dispatchNestedPreFling](./dispatch-nested-pre-fling.md) + +# dispatchNestedPreFling + +`fun dispatchNestedPreFling(velocityX: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`, velocityY: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/NestedWebView.kt#L140) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-nested-web-view/dispatch-nested-pre-scroll.md b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/dispatch-nested-pre-scroll.md new file mode 100644 index 00000000000..15525a1f504 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/dispatch-nested-pre-scroll.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [NestedWebView](index.md) / [dispatchNestedPreScroll](./dispatch-nested-pre-scroll.md) + +# dispatchNestedPreScroll + +`fun dispatchNestedPreScroll(dx: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dy: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, consumed: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`?, offsetInWindow: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/NestedWebView.kt#L132) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-nested-web-view/dispatch-nested-scroll.md b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/dispatch-nested-scroll.md new file mode 100644 index 00000000000..226f3673e2b --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/dispatch-nested-scroll.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [NestedWebView](index.md) / [dispatchNestedScroll](./dispatch-nested-scroll.md) + +# dispatchNestedScroll + +`fun dispatchNestedScroll(dxConsumed: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dyConsumed: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dxUnconsumed: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dyUnconsumed: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, offsetInWindow: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/NestedWebView.kt#L122) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-nested-web-view/has-nested-scrolling-parent.md b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/has-nested-scrolling-parent.md new file mode 100644 index 00000000000..f5e77e3794d --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/has-nested-scrolling-parent.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [NestedWebView](index.md) / [hasNestedScrollingParent](./has-nested-scrolling-parent.md) + +# hasNestedScrollingParent + +`fun hasNestedScrollingParent(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/NestedWebView.kt#L118) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-nested-web-view/index.md b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/index.md new file mode 100644 index 00000000000..39081d41ade --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/index.md @@ -0,0 +1,54 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [NestedWebView](./index.md) + +# NestedWebView + +`class NestedWebView : `[`WebView`](https://developer.android.com/reference/android/webkit/WebView.html)`, NestedScrollingChild` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/NestedWebView.kt#L31) + +WebView that supports nested scrolls (for using in a CoordinatorLayout). + +This code is a simplified version of the NestedScrollView implementation +which can be found in the support library: +[android.support.v4.widget.NestedScrollView](#) + +Based on: +https://github.com/takahirom/webview-in-coordinatorlayout + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `NestedWebView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`)`
WebView that supports nested scrolls (for using in a CoordinatorLayout). | + +### Functions + +| Name | Summary | +|---|---| +| [dispatchNestedFling](dispatch-nested-fling.md) | `fun dispatchNestedFling(velocityX: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`, velocityY: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`, consumed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [dispatchNestedPreFling](dispatch-nested-pre-fling.md) | `fun dispatchNestedPreFling(velocityX: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`, velocityY: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [dispatchNestedPreScroll](dispatch-nested-pre-scroll.md) | `fun dispatchNestedPreScroll(dx: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dy: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, consumed: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`?, offsetInWindow: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [dispatchNestedScroll](dispatch-nested-scroll.md) | `fun dispatchNestedScroll(dxConsumed: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dyConsumed: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dxUnconsumed: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dyUnconsumed: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, offsetInWindow: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [hasNestedScrollingParent](has-nested-scrolling-parent.md) | `fun hasNestedScrollingParent(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [isNestedScrollingEnabled](is-nested-scrolling-enabled.md) | `fun isNestedScrollingEnabled(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onTouchEvent](on-touch-event.md) | `fun onTouchEvent(ev: `[`MotionEvent`](https://developer.android.com/reference/android/view/MotionEvent.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [setNestedScrollingEnabled](set-nested-scrolling-enabled.md) | `fun setNestedScrollingEnabled(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) | +| [startNestedScroll](start-nested-scroll.md) | `fun startNestedScroll(axes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [stopNestedScroll](stop-nested-scroll.md) | `fun stopNestedScroll(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Extension Properties + +| Name | Summary | +|---|---| +| [isLTR](../../mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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? | + +### Extension Functions + +| Name | Summary | +|---|---| +| [forEach](../../mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md) | `fun `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`.forEach(action: (`[`View`](https://developer.android.com/reference/android/view/View.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 the given action on each View in this ViewGroup. | +| [hideKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.hideKeyboard(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Hides the soft input window. | +| [isGone](../../mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [isVisible](../../mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [setPadding](../../mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.setPadding(padding: `[`Padding`](../../mozilla.components.support.base.android/-padding/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Set a padding using [Padding](../../mozilla.components.support.base.android/-padding/index.md) object. | +| [showKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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/mozilla.components.browser.engine.system/-nested-web-view/is-nested-scrolling-enabled.md b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/is-nested-scrolling-enabled.md new file mode 100644 index 00000000000..1785bf6e331 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/is-nested-scrolling-enabled.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [NestedWebView](index.md) / [isNestedScrollingEnabled](./is-nested-scrolling-enabled.md) + +# isNestedScrollingEnabled + +`fun isNestedScrollingEnabled(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/NestedWebView.kt#L106) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-nested-web-view/on-touch-event.md b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/on-touch-event.md new file mode 100644 index 00000000000..fdc96beee90 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/on-touch-event.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [NestedWebView](index.md) / [onTouchEvent](./on-touch-event.md) + +# onTouchEvent + +`fun onTouchEvent(ev: `[`MotionEvent`](https://developer.android.com/reference/android/view/MotionEvent.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/NestedWebView.kt#L52) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-nested-web-view/set-nested-scrolling-enabled.md b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/set-nested-scrolling-enabled.md new file mode 100644 index 00000000000..7813187f725 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/set-nested-scrolling-enabled.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [NestedWebView](index.md) / [setNestedScrollingEnabled](./set-nested-scrolling-enabled.md) + +# setNestedScrollingEnabled + +`fun setNestedScrollingEnabled(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/NestedWebView.kt#L102) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-nested-web-view/start-nested-scroll.md b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/start-nested-scroll.md new file mode 100644 index 00000000000..f853ab66c84 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/start-nested-scroll.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [NestedWebView](index.md) / [startNestedScroll](./start-nested-scroll.md) + +# startNestedScroll + +`fun startNestedScroll(axes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/NestedWebView.kt#L110) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-nested-web-view/stop-nested-scroll.md b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/stop-nested-scroll.md new file mode 100644 index 00000000000..0e43eef4ce8 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-nested-web-view/stop-nested-scroll.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [NestedWebView](index.md) / [stopNestedScroll](./stop-nested-scroll.md) + +# stopNestedScroll + +`fun stopNestedScroll(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/NestedWebView.kt#L114) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session-state/-init-.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session-state/-init-.md new file mode 100644 index 00000000000..bc833b64a10 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session-state/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSessionState](index.md) / [<init>](./-init-.md) + +# <init> + +`SystemEngineSessionState(bundle: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?)` \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session-state/from-j-s-o-n.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session-state/from-j-s-o-n.md new file mode 100644 index 00000000000..2a026bae464 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session-state/from-j-s-o-n.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSessionState](index.md) / [fromJSON](./from-j-s-o-n.md) + +# fromJSON + +`fun fromJSON(json: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`SystemEngineSessionState`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSessionState.kt#L31) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session-state/index.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session-state/index.md new file mode 100644 index 00000000000..4cb3828f5a8 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session-state/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSessionState](./index.md) + +# SystemEngineSessionState + +`class SystemEngineSessionState : `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSessionState.kt#L11) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SystemEngineSessionState(bundle: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?)` | + +### Functions + +| Name | Summary | +|---|---| +| [toJSON](to-j-s-o-n.md) | `fun toJSON(): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)
Create a JSON representation of this state that can be saved to disk. | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [fromJSON](from-j-s-o-n.md) | `fun fromJSON(json: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`SystemEngineSessionState`](./index.md) | diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session-state/to-j-s-o-n.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session-state/to-j-s-o-n.md new file mode 100644 index 00000000000..1e108dc77aa --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session-state/to-j-s-o-n.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSessionState](index.md) / [toJSON](./to-j-s-o-n.md) + +# toJSON + +`fun toJSON(): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSessionState.kt#L14) + +Overrides [EngineSessionState.toJSON](../../mozilla.components.concept.engine/-engine-session-state/to-j-s-o-n.md) + +Create a JSON representation of this state that can be saved to disk. + +When reading JSON from disk [Engine.createSessionState](#) can be used to turn it back into an [EngineSessionState](../../mozilla.components.concept.engine/-engine-session-state/index.md) +instance. + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/-init-.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/-init-.md new file mode 100644 index 00000000000..2435f9191b1 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [<init>](./-init-.md) + +# <init> + +`SystemEngineSession(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, defaultSettings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md)`? = null)` + +WebView-based EngineSession implementation. + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/-web-setting/-init-.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/-web-setting/-init-.md new file mode 100644 index 00000000000..372fc1437bf --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/-web-setting/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.system](../../index.md) / [SystemEngineSession](../index.md) / [WebSetting](index.md) / [<init>](./-init-.md) + +# <init> + +`WebSetting(get: () -> `[`T`](index.md#T)`, set: (`[`T`](index.md#T)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/-web-setting/get-value.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/-web-setting/get-value.md new file mode 100644 index 00000000000..848017d3735 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/-web-setting/get-value.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.system](../../index.md) / [SystemEngineSession](../index.md) / [WebSetting](index.md) / [getValue](./get-value.md) + +# getValue + +`operator fun getValue(thisRef: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?, property: `[`KProperty`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-property/index.html)`<*>): `[`T`](index.md#T) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L218) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/-web-setting/index.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/-web-setting/index.md new file mode 100644 index 00000000000..cb72ce1cee6 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/-web-setting/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.system](../../index.md) / [SystemEngineSession](../index.md) / [WebSetting](./index.md) + +# WebSetting + +`class WebSetting` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L217) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `WebSetting(get: () -> `[`T`](index.md#T)`, set: (`[`T`](index.md#T)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [getValue](get-value.md) | `operator fun getValue(thisRef: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?, property: `[`KProperty`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-property/index.html)`<*>): `[`T`](index.md#T) | +| [setValue](set-value.md) | `operator fun setValue(thisRef: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?, property: `[`KProperty`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-property/index.html)`<*>, value: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/-web-setting/set-value.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/-web-setting/set-value.md new file mode 100644 index 00000000000..f5eb4b2c8b0 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/-web-setting/set-value.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.system](../../index.md) / [SystemEngineSession](../index.md) / [WebSetting](index.md) / [setValue](./set-value.md) + +# setValue + +`operator fun setValue(thisRef: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?, property: `[`KProperty`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-property/index.html)`<*>, value: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L219) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/capture-thumbnail.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/capture-thumbnail.md new file mode 100644 index 00000000000..c299e6d4d0b --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/capture-thumbnail.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [captureThumbnail](./capture-thumbnail.md) + +# captureThumbnail + +`fun captureThumbnail(): `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L335) + +Overrides [EngineSession.captureThumbnail](../../mozilla.components.concept.engine/-engine-session/capture-thumbnail.md) + +Takes a screenshot of the actual tab + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/clear-data.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/clear-data.md new file mode 100644 index 00000000000..2d66cd91cd5 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/clear-data.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [clearData](./clear-data.md) + +# clearData + +`fun clearData(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L172) + +Overrides [EngineSession.clearData](../../mozilla.components.concept.engine/-engine-session/clear-data.md) + +See [EngineSession.clearData](../../mozilla.components.concept.engine/-engine-session/clear-data.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/clear-find-matches.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/clear-find-matches.md new file mode 100644 index 00000000000..cad749e0aae --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/clear-find-matches.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [clearFindMatches](./clear-find-matches.md) + +# clearFindMatches + +`fun clearFindMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L207) + +Overrides [EngineSession.clearFindMatches](../../mozilla.components.concept.engine/-engine-session/clear-find-matches.md) + +See [EngineSession.clearFindMatches](../../mozilla.components.concept.engine/-engine-session/clear-find-matches.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/close.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/close.md new file mode 100644 index 00000000000..121abe1177a --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/close.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [close](./close.md) + +# close + +`fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L160) + +Overrides [EngineSession.close](../../mozilla.components.concept.engine/-engine-session/close.md) + +See [EngineSession.close](../../mozilla.components.concept.engine/-engine-session/close.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/disable-tracking-protection.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/disable-tracking-protection.md new file mode 100644 index 00000000000..1630c842b98 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/disable-tracking-protection.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [disableTrackingProtection](./disable-tracking-protection.md) + +# disableTrackingProtection + +`fun disableTrackingProtection(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L152) + +Overrides [EngineSession.disableTrackingProtection](../../mozilla.components.concept.engine/-engine-session/disable-tracking-protection.md) + +See [EngineSession.disableTrackingProtection](../../mozilla.components.concept.engine/-engine-session/disable-tracking-protection.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/enable-tracking-protection.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/enable-tracking-protection.md new file mode 100644 index 00000000000..bf54285ed41 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/enable-tracking-protection.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [enableTrackingProtection](./enable-tracking-protection.md) + +# enableTrackingProtection + +`fun enableTrackingProtection(policy: `[`TrackingProtectionPolicy`](../../mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L136) + +Overrides [EngineSession.enableTrackingProtection](../../mozilla.components.concept.engine/-engine-session/enable-tracking-protection.md) + +See [EngineSession.enableTrackingProtection](../../mozilla.components.concept.engine/-engine-session/enable-tracking-protection.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/exit-full-screen-mode.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/exit-full-screen-mode.md new file mode 100644 index 00000000000..bf997aac6c1 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/exit-full-screen-mode.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [exitFullScreenMode](./exit-full-screen-mode.md) + +# exitFullScreenMode + +`fun exitFullScreenMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L331) + +Overrides [EngineSession.exitFullScreenMode](../../mozilla.components.concept.engine/-engine-session/exit-full-screen-mode.md) + +See [EngineSession.exitFullScreenMode](../../mozilla.components.concept.engine/-engine-session/exit-full-screen-mode.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/find-all.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/find-all.md new file mode 100644 index 00000000000..9725c674fb6 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/find-all.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [findAll](./find-all.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L192) + +Overrides [EngineSession.findAll](../../mozilla.components.concept.engine/-engine-session/find-all.md) + +See [EngineSession.findAll](../../mozilla.components.concept.engine/-engine-session/find-all.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/find-next.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/find-next.md new file mode 100644 index 00000000000..f5ec3a27435 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/find-next.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [findNext](./find-next.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L200) + +Overrides [EngineSession.findNext](../../mozilla.components.concept.engine/-engine-session/find-next.md) + +See [EngineSession.findNext](../../mozilla.components.concept.engine/-engine-session/find-next.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/go-back.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/go-back.md new file mode 100644 index 00000000000..2518abffd3d --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/go-back.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [goBack](./go-back.md) + +# goBack + +`fun goBack(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L99) + +Overrides [EngineSession.goBack](../../mozilla.components.concept.engine/-engine-session/go-back.md) + +See [EngineSession.goBack](../../mozilla.components.concept.engine/-engine-session/go-back.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/go-forward.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/go-forward.md new file mode 100644 index 00000000000..fd3130fe45f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/go-forward.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [goForward](./go-forward.md) + +# goForward + +`fun goForward(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L106) + +Overrides [EngineSession.goForward](../../mozilla.components.concept.engine/-engine-session/go-forward.md) + +See [EngineSession.goForward](../../mozilla.components.concept.engine/-engine-session/go-forward.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/index.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/index.md new file mode 100644 index 00000000000..8f7cfce1331 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/index.md @@ -0,0 +1,49 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](./index.md) + +# SystemEngineSession + +`class SystemEngineSession : `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L41) + +WebView-based EngineSession implementation. + +### Types + +| Name | Summary | +|---|---| +| [WebSetting](-web-setting/index.md) | `class WebSetting` | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SystemEngineSession(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, defaultSettings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md)`? = null)`
WebView-based EngineSession implementation. | + +### Properties + +| Name | Summary | +|---|---| +| [settings](settings.md) | `val settings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md)
See [EngineSession.settings](../../mozilla.components.concept.engine/-engine-session/settings.md) | +| [webView](web-view.md) | `var webView: `[`WebView`](https://developer.android.com/reference/android/webkit/WebView.html) | + +### Functions + +| Name | Summary | +|---|---| +| [captureThumbnail](capture-thumbnail.md) | `fun captureThumbnail(): `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?`
Takes a screenshot of the actual tab | +| [clearData](clear-data.md) | `fun clearData(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.clearData](../../mozilla.components.concept.engine/-engine-session/clear-data.md) | +| [clearFindMatches](clear-find-matches.md) | `fun clearFindMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.clearFindMatches](../../mozilla.components.concept.engine/-engine-session/clear-find-matches.md) | +| [close](close.md) | `fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.close](../../mozilla.components.concept.engine/-engine-session/close.md) | +| [disableTrackingProtection](disable-tracking-protection.md) | `fun disableTrackingProtection(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.disableTrackingProtection](../../mozilla.components.concept.engine/-engine-session/disable-tracking-protection.md) | +| [enableTrackingProtection](enable-tracking-protection.md) | `fun enableTrackingProtection(policy: `[`TrackingProtectionPolicy`](../../mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.enableTrackingProtection](../../mozilla.components.concept.engine/-engine-session/enable-tracking-protection.md) | +| [exitFullScreenMode](exit-full-screen-mode.md) | `fun exitFullScreenMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.exitFullScreenMode](../../mozilla.components.concept.engine/-engine-session/exit-full-screen-mode.md) | +| [findAll](find-all.md) | `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](../../mozilla.components.concept.engine/-engine-session/find-all.md) | +| [findNext](find-next.md) | `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](../../mozilla.components.concept.engine/-engine-session/find-next.md) | +| [goBack](go-back.md) | `fun goBack(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.goBack](../../mozilla.components.concept.engine/-engine-session/go-back.md) | +| [goForward](go-forward.md) | `fun goForward(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.goForward](../../mozilla.components.concept.engine/-engine-session/go-forward.md) | +| [loadData](load-data.md) | `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](../../mozilla.components.concept.engine/-engine-session/load-data.md) | +| [loadUrl](load-url.md) | `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](../../mozilla.components.concept.engine/-engine-session/load-url.md) | +| [reload](reload.md) | `fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.reload](../../mozilla.components.concept.engine/-engine-session/reload.md) | +| [restoreState](restore-state.md) | `fun restoreState(state: `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.restoreState](../../mozilla.components.concept.engine/-engine-session/restore-state.md) | +| [saveState](save-state.md) | `fun saveState(): `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md)
See [EngineSession.saveState](../../mozilla.components.concept.engine/-engine-session/save-state.md) | +| [stopLoading](stop-loading.md) | `fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
See [EngineSession.stopLoading](../../mozilla.components.concept.engine/-engine-session/stop-loading.md) | +| [toggleDesktopMode](toggle-desktop-mode.md) | `fun toggleDesktopMode(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.toggleDesktopMode](../../mozilla.components.concept.engine/-engine-session/toggle-desktop-mode.md) | diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/load-data.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/load-data.md new file mode 100644 index 00000000000..e2e7f093c57 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/load-data.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [loadData](./load-data.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L78) + +Overrides [EngineSession.loadData](../../mozilla.components.concept.engine/-engine-session/load-data.md) + +See [EngineSession.loadData](../../mozilla.components.concept.engine/-engine-session/load-data.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/load-url.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/load-url.md new file mode 100644 index 00000000000..3be182dae0f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/load-url.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [loadUrl](./load-url.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L68) + +Overrides [EngineSession.loadUrl](../../mozilla.components.concept.engine/-engine-session/load-url.md) + +See [EngineSession.loadUrl](../../mozilla.components.concept.engine/-engine-session/load-url.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/reload.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/reload.md new file mode 100644 index 00000000000..570538bf8b5 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/reload.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [reload](./reload.md) + +# reload + +`fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L92) + +Overrides [EngineSession.reload](../../mozilla.components.concept.engine/-engine-session/reload.md) + +See [EngineSession.reload](../../mozilla.components.concept.engine/-engine-session/reload.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/restore-state.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/restore-state.md new file mode 100644 index 00000000000..a74643c91f2 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/restore-state.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [restoreState](./restore-state.md) + +# restoreState + +`fun restoreState(state: `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L125) + +Overrides [EngineSession.restoreState](../../mozilla.components.concept.engine/-engine-session/restore-state.md) + +See [EngineSession.restoreState](../../mozilla.components.concept.engine/-engine-session/restore-state.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/save-state.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/save-state.md new file mode 100644 index 00000000000..3d3b9404934 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/save-state.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [saveState](./save-state.md) + +# saveState + +`fun saveState(): `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L113) + +Overrides [EngineSession.saveState](../../mozilla.components.concept.engine/-engine-session/save-state.md) + +See [EngineSession.saveState](../../mozilla.components.concept.engine/-engine-session/save-state.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/settings.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/settings.md new file mode 100644 index 00000000000..110c7f7bfe3 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/settings.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [settings](./settings.md) + +# settings + +`val settings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L214) + +Overrides [EngineSession.settings](../../mozilla.components.concept.engine/-engine-session/settings.md) + +See [EngineSession.settings](../../mozilla.components.concept.engine/-engine-session/settings.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/stop-loading.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/stop-loading.md new file mode 100644 index 00000000000..d0c2830957e --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/stop-loading.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [stopLoading](./stop-loading.md) + +# stopLoading + +`fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L85) + +Overrides [EngineSession.stopLoading](../../mozilla.components.concept.engine/-engine-session/stop-loading.md) + +See [EngineSession.stopLoading](../../mozilla.components.concept.engine/-engine-session/stop-loading.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/toggle-desktop-mode.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/toggle-desktop-mode.md new file mode 100644 index 00000000000..f68264aca25 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/toggle-desktop-mode.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [toggleDesktopMode](./toggle-desktop-mode.md) + +# toggleDesktopMode + +`fun toggleDesktopMode(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L316) + +Overrides [EngineSession.toggleDesktopMode](../../mozilla.components.concept.engine/-engine-session/toggle-desktop-mode.md) + +See [EngineSession.toggleDesktopMode](../../mozilla.components.concept.engine/-engine-session/toggle-desktop-mode.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-session/web-view.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/web-view.md new file mode 100644 index 00000000000..4c4eb349c4b --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-session/web-view.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineSession](index.md) / [webView](./web-view.md) + +# webView + +`@Volatile var webView: `[`WebView`](https://developer.android.com/reference/android/webkit/WebView.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt#L55) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/-init-.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/-init-.md new file mode 100644 index 00000000000..718d5d26884 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.system](../../index.md) / [SystemEngineView](../index.md) / [ImageHandler](index.md) / [<init>](./-init-.md) + +# <init> + +`ImageHandler(session: `[`SystemEngineSession`](../../-system-engine-session/index.md)`?)` \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/handle-message.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/handle-message.md new file mode 100644 index 00000000000..3d2f163bf6f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/handle-message.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.system](../../index.md) / [SystemEngineView](../index.md) / [ImageHandler](index.md) / [handleMessage](./handle-message.md) + +# handleMessage + +`fun handleMessage(msg: `[`Message`](https://developer.android.com/reference/android/os/Message.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineView.kt#L543) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/index.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/index.md new file mode 100644 index 00000000000..1dd0a6a56d4 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/index.md @@ -0,0 +1,23 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.system](../../index.md) / [SystemEngineView](../index.md) / [ImageHandler](./index.md) + +# ImageHandler + +`class ImageHandler : `[`Handler`](https://developer.android.com/reference/android/os/Handler.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineView.kt#L542) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ImageHandler(session: `[`SystemEngineSession`](../../-system-engine-session/index.md)`?)` | + +### Properties + +| Name | Summary | +|---|---| +| [session](session.md) | `val session: `[`SystemEngineSession`](../../-system-engine-session/index.md)`?` | + +### Functions + +| Name | Summary | +|---|---| +| [handleMessage](handle-message.md) | `fun handleMessage(msg: `[`Message`](https://developer.android.com/reference/android/os/Message.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/session.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/session.md new file mode 100644 index 00000000000..7267c2cc1c0 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/-image-handler/session.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.engine.system](../../index.md) / [SystemEngineView](../index.md) / [ImageHandler](index.md) / [session](./session.md) + +# session + +`val session: `[`SystemEngineSession`](../../-system-engine-session/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineView.kt#L542) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-view/-init-.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/-init-.md new file mode 100644 index 00000000000..e170309bc56 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineView](index.md) / [<init>](./-init-.md) + +# <init> + +`SystemEngineView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = 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/mozilla.components.browser.engine.system/-system-engine-view/can-scroll-vertically-down.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/can-scroll-vertically-down.md new file mode 100644 index 00000000000..1b1d4cf6204 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/can-scroll-vertically-down.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineView](index.md) / [canScrollVerticallyDown](./can-scroll-vertically-down.md) + +# canScrollVerticallyDown + +`fun canScrollVerticallyDown(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineView.kt#L555) + +Overrides [EngineView.canScrollVerticallyDown](../../mozilla.components.concept.engine/-engine-view/can-scroll-vertically-down.md) + +Check if [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) can be scrolled vertically down. +true if can and false otherwise. + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-view/index.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/index.md new file mode 100644 index 00000000000..1d4729c947f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/index.md @@ -0,0 +1,58 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineView](./index.md) + +# SystemEngineView + +`class SystemEngineView : `[`FrameLayout`](https://developer.android.com/reference/android/widget/FrameLayout.html)`, `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md)`, `[`OnLongClickListener`](https://developer.android.com/reference/android/view/View/OnLongClickListener.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineView.kt#L59) + +WebView-based implementation of EngineView. + +### Types + +| Name | Summary | +|---|---| +| [ImageHandler](-image-handler/index.md) | `class ImageHandler : `[`Handler`](https://developer.android.com/reference/android/os/Handler.html) | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SystemEngineView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)`
WebView-based implementation of EngineView. | + +### Functions + +| Name | Summary | +|---|---| +| [canScrollVerticallyDown](can-scroll-vertically-down.md) | `fun canScrollVerticallyDown(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Check if [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) can be scrolled vertically down. true if can and false otherwise. | +| [onDestroy](on-destroy.md) | `fun onDestroy(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_DESTROY](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | +| [onLongClick](on-long-click.md) | `fun onLongClick(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onPause](on-pause.md) | `fun onPause(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_PAUSE](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | +| [onResume](on-resume.md) | `fun onResume(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_RESUME](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | +| [render](render.md) | `fun render(session: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Render the content of the given session. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [asView](../../mozilla.components.concept.engine/-engine-view/as-view.md) | `open fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html)
Convenience method to cast the implementation of this interface to an Android View object. | +| [onCreate](../../mozilla.components.concept.engine/-engine-view/on-create.md) | `open fun onCreate(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_CREATE](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | +| [onStart](../../mozilla.components.concept.engine/-engine-view/on-start.md) | `open fun onStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_START](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | +| [onStop](../../mozilla.components.concept.engine/-engine-view/on-stop.md) | `open fun onStop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_STOP](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) implementations for details. | + +### Extension Properties + +| Name | Summary | +|---|---| +| [isLTR](../../mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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? | + +### Extension Functions + +| Name | Summary | +|---|---| +| [forEach](../../mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md) | `fun `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`.forEach(action: (`[`View`](https://developer.android.com/reference/android/view/View.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 the given action on each View in this ViewGroup. | +| [hideKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.hideKeyboard(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Hides the soft input window. | +| [isGone](../../mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [isVisible](../../mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [setPadding](../../mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.setPadding(padding: `[`Padding`](../../mozilla.components.support.base.android/-padding/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Set a padding using [Padding](../../mozilla.components.support.base.android/-padding/index.md) object. | +| [showKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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/mozilla.components.browser.engine.system/-system-engine-view/on-destroy.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/on-destroy.md new file mode 100644 index 00000000000..98eab5c7a4d --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/on-destroy.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineView](index.md) / [onDestroy](./on-destroy.md) + +# onDestroy + +`fun onDestroy(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineView.kt#L101) + +Overrides [EngineView.onDestroy](../../mozilla.components.concept.engine/-engine-view/on-destroy.md) + +To be called in response to [Lifecycle.Event.ON_DESTROY](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) +implementations for details. + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-view/on-long-click.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/on-long-click.md new file mode 100644 index 00000000000..fd3d979d0c7 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/on-long-click.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineView](index.md) / [onLongClick](./on-long-click.md) + +# onLongClick + +`fun onLongClick(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineView.kt#L82) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-view/on-pause.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/on-pause.md new file mode 100644 index 00000000000..8dab394b4c0 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/on-pause.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineView](index.md) / [onPause](./on-pause.md) + +# onPause + +`fun onPause(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineView.kt#L87) + +Overrides [EngineView.onPause](../../mozilla.components.concept.engine/-engine-view/on-pause.md) + +To be called in response to [Lifecycle.Event.ON_PAUSE](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) +implementations for details. + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-view/on-resume.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/on-resume.md new file mode 100644 index 00000000000..924beb7fe69 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/on-resume.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineView](index.md) / [onResume](./on-resume.md) + +# onResume + +`fun onResume(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineView.kt#L94) + +Overrides [EngineView.onResume](../../mozilla.components.concept.engine/-engine-view/on-resume.md) + +To be called in response to [Lifecycle.Event.ON_RESUME](#). See [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) +implementations for details. + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine-view/render.md b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/render.md new file mode 100644 index 00000000000..903df914897 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine-view/render.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngineView](index.md) / [render](./render.md) + +# render + +`fun render(session: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineView.kt#L74) + +Overrides [EngineView.render](../../mozilla.components.concept.engine/-engine-view/render.md) + +Render the content of the given session. + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine/-init-.md b/docs/api/mozilla.components.browser.engine.system/-system-engine/-init-.md new file mode 100644 index 00000000000..b9f1b78dfaa --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngine](index.md) / [<init>](./-init-.md) + +# <init> + +`SystemEngine(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, defaultSettings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md)` = DefaultSettings())` + +WebView-based implementation of the Engine interface. + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine/create-session-state.md b/docs/api/mozilla.components.browser.engine.system/-system-engine/create-session-state.md new file mode 100644 index 00000000000..75fbd9de14c --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine/create-session-state.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngine](index.md) / [createSessionState](./create-session-state.md) + +# createSessionState + +`fun createSessionState(json: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngine.kt#L62) + +Overrides [Engine.createSessionState](../../mozilla.components.concept.engine/-engine/create-session-state.md) + +Create a new [EngineSessionState](../../mozilla.components.concept.engine/-engine-session-state/index.md) instance from the serialized JSON representation. + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine/create-session.md b/docs/api/mozilla.components.browser.engine.system/-system-engine/create-session.md new file mode 100644 index 00000000000..8df6517e696 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine/create-session.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngine](index.md) / [createSession](./create-session.md) + +# createSession + +`fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngine.kt#L42) + +Overrides [Engine.createSession](../../mozilla.components.concept.engine/-engine/create-session.md) + +Creates a new WebView-based EngineSession implementation. + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine/create-view.md b/docs/api/mozilla.components.browser.engine.system/-system-engine/create-view.md new file mode 100644 index 00000000000..5bf66b844bd --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine/create-view.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngine](index.md) / [createView](./create-view.md) + +# createView + +`fun createView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`?): `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngine.kt#L35) + +Overrides [Engine.createView](../../mozilla.components.concept.engine/-engine/create-view.md) + +Creates a new WebView-based EngineView implementation. + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine/default-user-agent.md b/docs/api/mozilla.components.browser.engine.system/-system-engine/default-user-agent.md new file mode 100644 index 00000000000..4bb2f5da03f --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine/default-user-agent.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngine](index.md) / [defaultUserAgent](./default-user-agent.md) + +# defaultUserAgent + +`var defaultUserAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngine.kt#L107) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine/index.md b/docs/api/mozilla.components.browser.engine.system/-system-engine/index.md new file mode 100644 index 00000000000..0f2a3ed141a --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine/index.md @@ -0,0 +1,35 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngine](./index.md) + +# SystemEngine + +`class SystemEngine : `[`Engine`](../../mozilla.components.concept.engine/-engine/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngine.kt#L25) + +WebView-based implementation of the Engine interface. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SystemEngine(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, defaultSettings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md)` = DefaultSettings())`
WebView-based implementation of the Engine interface. | + +### Properties + +| Name | Summary | +|---|---| +| [settings](settings.md) | `val settings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md)
See [Engine.settings](../../mozilla.components.concept.engine/-engine/settings.md) | + +### Functions + +| Name | Summary | +|---|---| +| [createSession](create-session.md) | `fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)
Creates a new WebView-based EngineSession implementation. | +| [createSessionState](create-session-state.md) | `fun createSessionState(json: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`EngineSessionState`](../../mozilla.components.concept.engine/-engine-session-state/index.md)
Create a new [EngineSessionState](../../mozilla.components.concept.engine/-engine-session-state/index.md) instance from the serialized JSON representation. | +| [createView](create-view.md) | `fun createView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`?): `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md)
Creates a new WebView-based EngineView implementation. | +| [name](name.md) | `fun name(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
See [Engine.name](../../mozilla.components.concept.engine/-engine/name.md) | +| [speculativeConnect](speculative-connect.md) | `fun speculativeConnect(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)
Opens a speculative connection to the host of [url](speculative-connect.md#mozilla.components.browser.engine.system.SystemEngine$speculativeConnect(kotlin.String)/url). | + +### Companion Object Properties + +| Name | Summary | +|---|---| +| [defaultUserAgent](default-user-agent.md) | `var defaultUserAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine/name.md b/docs/api/mozilla.components.browser.engine.system/-system-engine/name.md new file mode 100644 index 00000000000..d0a08c7d506 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine/name.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngine](index.md) / [name](./name.md) + +# name + +`fun name(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngine.kt#L60) + +Overrides [Engine.name](../../mozilla.components.concept.engine/-engine/name.md) + +See [Engine.name](../../mozilla.components.concept.engine/-engine/name.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine/settings.md b/docs/api/mozilla.components.browser.engine.system/-system-engine/settings.md new file mode 100644 index 00000000000..e6055bacbe5 --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine/settings.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngine](index.md) / [settings](./settings.md) + +# settings + +`val settings: `[`Settings`](../../mozilla.components.concept.engine/-settings/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngine.kt#L69) + +Overrides [Engine.settings](../../mozilla.components.concept.engine/-engine/settings.md) + +See [Engine.settings](../../mozilla.components.concept.engine/-engine/settings.md) + diff --git a/docs/api/mozilla.components.browser.engine.system/-system-engine/speculative-connect.md b/docs/api/mozilla.components.browser.engine.system/-system-engine/speculative-connect.md new file mode 100644 index 00000000000..860bd550dbc --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/-system-engine/speculative-connect.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.engine.system](../index.md) / [SystemEngine](index.md) / [speculativeConnect](./speculative-connect.md) + +# speculativeConnect + +`fun speculativeConnect(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/engine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngine.kt#L55) + +Overrides [Engine.speculativeConnect](../../mozilla.components.concept.engine/-engine/speculative-connect.md) + +Opens a speculative connection to the host of [url](speculative-connect.md#mozilla.components.browser.engine.system.SystemEngine$speculativeConnect(kotlin.String)/url). + +Note: This implementation is a no-op. + diff --git a/docs/api/mozilla.components.browser.engine.system/index.md b/docs/api/mozilla.components.browser.engine.system/index.md new file mode 100644 index 00000000000..a3abbceff2a --- /dev/null +++ b/docs/api/mozilla.components.browser.engine.system/index.md @@ -0,0 +1,13 @@ +[android-components](../index.md) / [mozilla.components.browser.engine.system](./index.md) + +## Package mozilla.components.browser.engine.system + +### Types + +| Name | Summary | +|---|---| +| [NestedWebView](-nested-web-view/index.md) | `class NestedWebView : `[`WebView`](https://developer.android.com/reference/android/webkit/WebView.html)`, NestedScrollingChild`
WebView that supports nested scrolls (for using in a CoordinatorLayout). | +| [SystemEngine](-system-engine/index.md) | `class SystemEngine : `[`Engine`](../mozilla.components.concept.engine/-engine/index.md)
WebView-based implementation of the Engine interface. | +| [SystemEngineSession](-system-engine-session/index.md) | `class SystemEngineSession : `[`EngineSession`](../mozilla.components.concept.engine/-engine-session/index.md)
WebView-based EngineSession implementation. | +| [SystemEngineSessionState](-system-engine-session-state/index.md) | `class SystemEngineSessionState : `[`EngineSessionState`](../mozilla.components.concept.engine/-engine-session-state/index.md) | +| [SystemEngineView](-system-engine-view/index.md) | `class SystemEngineView : `[`FrameLayout`](https://developer.android.com/reference/android/widget/FrameLayout.html)`, `[`EngineView`](../mozilla.components.concept.engine/-engine-view/index.md)`, `[`OnLongClickListener`](https://developer.android.com/reference/android/view/View/OnLongClickListener.html)
WebView-based implementation of EngineView. | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-pages/create-error-page.md b/docs/api/mozilla.components.browser.errorpages/-error-pages/create-error-page.md new file mode 100644 index 00000000000..cc162500c39 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-pages/create-error-page.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorPages](index.md) / [createErrorPage](./create-error-page.md) + +# createErrorPage + +`fun createErrorPage(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, errorType: `[`ErrorType`](../-error-type/index.md)`, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, @RawRes htmlResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = R.raw.error_pages, @RawRes cssResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = R.raw.error_style): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L16) + +Load and generate error page for the given error type and html/css resources + diff --git a/docs/api/mozilla.components.browser.errorpages/-error-pages/index.md b/docs/api/mozilla.components.browser.errorpages/-error-pages/index.md new file mode 100644 index 00000000000..de89ed57712 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-pages/index.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorPages](./index.md) + +# ErrorPages + +`object ErrorPages` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L11) + +### Functions + +| Name | Summary | +|---|---| +| [createErrorPage](create-error-page.md) | `fun createErrorPage(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, errorType: `[`ErrorType`](../-error-type/index.md)`, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, htmlResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = R.raw.error_pages, cssResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = R.raw.error_style): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Load and generate error page for the given error type and html/css resources | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-c-o-n-n-e-c-t-i-o-n_-r-e-f-u-s-e-d.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-c-o-n-n-e-c-t-i-o-n_-r-e-f-u-s-e-d.md new file mode 100644 index 00000000000..a600547162c --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-c-o-n-n-e-c-t-i-o-n_-r-e-f-u-s-e-d.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_CONNECTION_REFUSED](./-e-r-r-o-r_-c-o-n-n-e-c-t-i-o-n_-r-e-f-u-s-e-d.md) + +# ERROR_CONNECTION_REFUSED + +`ERROR_CONNECTION_REFUSED` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L65) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-c-o-n-t-e-n-t_-c-r-a-s-h-e-d.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-c-o-n-t-e-n-t_-c-r-a-s-h-e-d.md new file mode 100644 index 00000000000..b0fcee943e7 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-c-o-n-t-e-n-t_-c-r-a-s-h-e-d.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_CONTENT_CRASHED](./-e-r-r-o-r_-c-o-n-t-e-n-t_-c-r-a-s-h-e-d.md) + +# ERROR_CONTENT_CRASHED + +`ERROR_CONTENT_CRASHED` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L97) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-c-o-r-r-u-p-t-e-d_-c-o-n-t-e-n-t.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-c-o-r-r-u-p-t-e-d_-c-o-n-t-e-n-t.md new file mode 100644 index 00000000000..4052cb25ffa --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-c-o-r-r-u-p-t-e-d_-c-o-n-t-e-n-t.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_CORRUPTED_CONTENT](./-e-r-r-o-r_-c-o-r-r-u-p-t-e-d_-c-o-n-t-e-n-t.md) + +# ERROR_CORRUPTED_CONTENT + +`ERROR_CORRUPTED_CONTENT` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L93) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-f-i-l-e_-a-c-c-e-s-s_-d-e-n-i-e-d.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-f-i-l-e_-a-c-c-e-s-s_-d-e-n-i-e-d.md new file mode 100644 index 00000000000..7ac45d1d557 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-f-i-l-e_-a-c-c-e-s-s_-d-e-n-i-e-d.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_FILE_ACCESS_DENIED](./-e-r-r-o-r_-f-i-l-e_-a-c-c-e-s-s_-d-e-n-i-e-d.md) + +# ERROR_FILE_ACCESS_DENIED + +`ERROR_FILE_ACCESS_DENIED` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L121) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-f-i-l-e_-n-o-t_-f-o-u-n-d.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-f-i-l-e_-n-o-t_-f-o-u-n-d.md new file mode 100644 index 00000000000..eb1bcc41b12 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-f-i-l-e_-n-o-t_-f-o-u-n-d.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_FILE_NOT_FOUND](./-e-r-r-o-r_-f-i-l-e_-n-o-t_-f-o-u-n-d.md) + +# ERROR_FILE_NOT_FOUND + +`ERROR_FILE_NOT_FOUND` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L117) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-i-n-v-a-l-i-d_-c-o-n-t-e-n-t_-e-n-c-o-d-i-n-g.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-i-n-v-a-l-i-d_-c-o-n-t-e-n-t_-e-n-c-o-d-i-n-g.md new file mode 100644 index 00000000000..bf2b3d092cd --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-i-n-v-a-l-i-d_-c-o-n-t-e-n-t_-e-n-c-o-d-i-n-g.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_INVALID_CONTENT_ENCODING](./-e-r-r-o-r_-i-n-v-a-l-i-d_-c-o-n-t-e-n-t_-e-n-c-o-d-i-n-g.md) + +# ERROR_INVALID_CONTENT_ENCODING + +`ERROR_INVALID_CONTENT_ENCODING` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L101) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-m-a-l-f-o-r-m-e-d_-u-r-i.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-m-a-l-f-o-r-m-e-d_-u-r-i.md new file mode 100644 index 00000000000..71577e7b809 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-m-a-l-f-o-r-m-e-d_-u-r-i.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_MALFORMED_URI](./-e-r-r-o-r_-m-a-l-f-o-r-m-e-d_-u-r-i.md) + +# ERROR_MALFORMED_URI + +`ERROR_MALFORMED_URI` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L109) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-n-e-t_-i-n-t-e-r-r-u-p-t.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-n-e-t_-i-n-t-e-r-r-u-p-t.md new file mode 100644 index 00000000000..407c10201e2 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-n-e-t_-i-n-t-e-r-r-u-p-t.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_NET_INTERRUPT](./-e-r-r-o-r_-n-e-t_-i-n-t-e-r-r-u-p-t.md) + +# ERROR_NET_INTERRUPT + +`ERROR_NET_INTERRUPT` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L57) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-n-e-t_-r-e-s-e-t.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-n-e-t_-r-e-s-e-t.md new file mode 100644 index 00000000000..44367abe172 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-n-e-t_-r-e-s-e-t.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_NET_RESET](./-e-r-r-o-r_-n-e-t_-r-e-s-e-t.md) + +# ERROR_NET_RESET + +`ERROR_NET_RESET` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L85) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-n-e-t_-t-i-m-e-o-u-t.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-n-e-t_-t-i-m-e-o-u-t.md new file mode 100644 index 00000000000..91d95af3152 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-n-e-t_-t-i-m-e-o-u-t.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_NET_TIMEOUT](./-e-r-r-o-r_-n-e-t_-t-i-m-e-o-u-t.md) + +# ERROR_NET_TIMEOUT + +`ERROR_NET_TIMEOUT` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L61) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-o-f-f-l-i-n-e.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-o-f-f-l-i-n-e.md new file mode 100644 index 00000000000..4e8f91d4787 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-o-f-f-l-i-n-e.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_OFFLINE](./-e-r-r-o-r_-o-f-f-l-i-n-e.md) + +# ERROR_OFFLINE + +`ERROR_OFFLINE` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L77) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-p-o-r-t_-b-l-o-c-k-e-d.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-p-o-r-t_-b-l-o-c-k-e-d.md new file mode 100644 index 00000000000..88e670ce8cd --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-p-o-r-t_-b-l-o-c-k-e-d.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_PORT_BLOCKED](./-e-r-r-o-r_-p-o-r-t_-b-l-o-c-k-e-d.md) + +# ERROR_PORT_BLOCKED + +`ERROR_PORT_BLOCKED` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L81) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-p-r-o-x-y_-c-o-n-n-e-c-t-i-o-n_-r-e-f-u-s-e-d.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-p-r-o-x-y_-c-o-n-n-e-c-t-i-o-n_-r-e-f-u-s-e-d.md new file mode 100644 index 00000000000..abc70678a37 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-p-r-o-x-y_-c-o-n-n-e-c-t-i-o-n_-r-e-f-u-s-e-d.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_PROXY_CONNECTION_REFUSED](./-e-r-r-o-r_-p-r-o-x-y_-c-o-n-n-e-c-t-i-o-n_-r-e-f-u-s-e-d.md) + +# ERROR_PROXY_CONNECTION_REFUSED + +`ERROR_PROXY_CONNECTION_REFUSED` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L125) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-r-e-d-i-r-e-c-t_-l-o-o-p.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-r-e-d-i-r-e-c-t_-l-o-o-p.md new file mode 100644 index 00000000000..396d5941e3a --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-r-e-d-i-r-e-c-t_-l-o-o-p.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_REDIRECT_LOOP](./-e-r-r-o-r_-r-e-d-i-r-e-c-t_-l-o-o-p.md) + +# ERROR_REDIRECT_LOOP + +`ERROR_REDIRECT_LOOP` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L73) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-h-a-r-m-f-u-l_-u-r-i.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-h-a-r-m-f-u-l_-u-r-i.md new file mode 100644 index 00000000000..7e458a74a99 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-h-a-r-m-f-u-l_-u-r-i.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_SAFEBROWSING_HARMFUL_URI](./-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-h-a-r-m-f-u-l_-u-r-i.md) + +# ERROR_SAFEBROWSING_HARMFUL_URI + +`ERROR_SAFEBROWSING_HARMFUL_URI` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L141) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-m-a-l-w-a-r-e_-u-r-i.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-m-a-l-w-a-r-e_-u-r-i.md new file mode 100644 index 00000000000..8c37418fbd5 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-m-a-l-w-a-r-e_-u-r-i.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_SAFEBROWSING_MALWARE_URI](./-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-m-a-l-w-a-r-e_-u-r-i.md) + +# ERROR_SAFEBROWSING_MALWARE_URI + +`ERROR_SAFEBROWSING_MALWARE_URI` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L133) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-p-h-i-s-h-i-n-g_-u-r-i.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-p-h-i-s-h-i-n-g_-u-r-i.md new file mode 100644 index 00000000000..2bbfe625449 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-p-h-i-s-h-i-n-g_-u-r-i.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_SAFEBROWSING_PHISHING_URI](./-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-p-h-i-s-h-i-n-g_-u-r-i.md) + +# ERROR_SAFEBROWSING_PHISHING_URI + +`ERROR_SAFEBROWSING_PHISHING_URI` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L145) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-u-n-w-a-n-t-e-d_-u-r-i.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-u-n-w-a-n-t-e-d_-u-r-i.md new file mode 100644 index 00000000000..7c1ca2fc9b7 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-u-n-w-a-n-t-e-d_-u-r-i.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_SAFEBROWSING_UNWANTED_URI](./-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-u-n-w-a-n-t-e-d_-u-r-i.md) + +# ERROR_SAFEBROWSING_UNWANTED_URI + +`ERROR_SAFEBROWSING_UNWANTED_URI` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L137) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-e-c-u-r-i-t-y_-b-a-d_-c-e-r-t.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-e-c-u-r-i-t-y_-b-a-d_-c-e-r-t.md new file mode 100644 index 00000000000..c44363ad236 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-e-c-u-r-i-t-y_-b-a-d_-c-e-r-t.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_SECURITY_BAD_CERT](./-e-r-r-o-r_-s-e-c-u-r-i-t-y_-b-a-d_-c-e-r-t.md) + +# ERROR_SECURITY_BAD_CERT + +`ERROR_SECURITY_BAD_CERT` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L53) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-e-c-u-r-i-t-y_-s-s-l.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-e-c-u-r-i-t-y_-s-s-l.md new file mode 100644 index 00000000000..26e9cb4bf8a --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-s-e-c-u-r-i-t-y_-s-s-l.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_SECURITY_SSL](./-e-r-r-o-r_-s-e-c-u-r-i-t-y_-s-s-l.md) + +# ERROR_SECURITY_SSL + +`ERROR_SECURITY_SSL` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L49) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-k-n-o-w-n_-h-o-s-t.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-k-n-o-w-n_-h-o-s-t.md new file mode 100644 index 00000000000..f2c1848c7cc --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-k-n-o-w-n_-h-o-s-t.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_UNKNOWN_HOST](./-e-r-r-o-r_-u-n-k-n-o-w-n_-h-o-s-t.md) + +# ERROR_UNKNOWN_HOST + +`ERROR_UNKNOWN_HOST` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L105) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-k-n-o-w-n_-p-r-o-t-o-c-o-l.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-k-n-o-w-n_-p-r-o-t-o-c-o-l.md new file mode 100644 index 00000000000..4f3ef31ee3e --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-k-n-o-w-n_-p-r-o-t-o-c-o-l.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_UNKNOWN_PROTOCOL](./-e-r-r-o-r_-u-n-k-n-o-w-n_-p-r-o-t-o-c-o-l.md) + +# ERROR_UNKNOWN_PROTOCOL + +`ERROR_UNKNOWN_PROTOCOL` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L113) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-k-n-o-w-n_-p-r-o-x-y_-h-o-s-t.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-k-n-o-w-n_-p-r-o-x-y_-h-o-s-t.md new file mode 100644 index 00000000000..c9d8c7dbc23 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-k-n-o-w-n_-p-r-o-x-y_-h-o-s-t.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_UNKNOWN_PROXY_HOST](./-e-r-r-o-r_-u-n-k-n-o-w-n_-p-r-o-x-y_-h-o-s-t.md) + +# ERROR_UNKNOWN_PROXY_HOST + +`ERROR_UNKNOWN_PROXY_HOST` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L129) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-k-n-o-w-n_-s-o-c-k-e-t_-t-y-p-e.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-k-n-o-w-n_-s-o-c-k-e-t_-t-y-p-e.md new file mode 100644 index 00000000000..15c8fd6c8b3 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-k-n-o-w-n_-s-o-c-k-e-t_-t-y-p-e.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_UNKNOWN_SOCKET_TYPE](./-e-r-r-o-r_-u-n-k-n-o-w-n_-s-o-c-k-e-t_-t-y-p-e.md) + +# ERROR_UNKNOWN_SOCKET_TYPE + +`ERROR_UNKNOWN_SOCKET_TYPE` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L69) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-s-a-f-e_-c-o-n-t-e-n-t_-t-y-p-e.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-s-a-f-e_-c-o-n-t-e-n-t_-t-y-p-e.md new file mode 100644 index 00000000000..0350b3d2e6b --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-e-r-r-o-r_-u-n-s-a-f-e_-c-o-n-t-e-n-t_-t-y-p-e.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [ERROR_UNSAFE_CONTENT_TYPE](./-e-r-r-o-r_-u-n-s-a-f-e_-c-o-n-t-e-n-t_-t-y-p-e.md) + +# ERROR_UNSAFE_CONTENT_TYPE + +`ERROR_UNSAFE_CONTENT_TYPE` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L89) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/-u-n-k-n-o-w-n.md b/docs/api/mozilla.components.browser.errorpages/-error-type/-u-n-k-n-o-w-n.md new file mode 100644 index 00000000000..848db02d8b1 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/-u-n-k-n-o-w-n.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [UNKNOWN](./-u-n-k-n-o-w-n.md) + +# UNKNOWN + +`UNKNOWN` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L45) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/index.md b/docs/api/mozilla.components.browser.errorpages/-error-type/index.md new file mode 100644 index 00000000000..6d30b23794a --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/index.md @@ -0,0 +1,45 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](./index.md) + +# ErrorType + +`enum class ErrorType` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L41) + +Enum containing all supported error types that we can display an error page for. + +### Enum Values + +| Name | Summary | +|---|---| +| [UNKNOWN](-u-n-k-n-o-w-n.md) | | +| [ERROR_SECURITY_SSL](-e-r-r-o-r_-s-e-c-u-r-i-t-y_-s-s-l.md) | | +| [ERROR_SECURITY_BAD_CERT](-e-r-r-o-r_-s-e-c-u-r-i-t-y_-b-a-d_-c-e-r-t.md) | | +| [ERROR_NET_INTERRUPT](-e-r-r-o-r_-n-e-t_-i-n-t-e-r-r-u-p-t.md) | | +| [ERROR_NET_TIMEOUT](-e-r-r-o-r_-n-e-t_-t-i-m-e-o-u-t.md) | | +| [ERROR_CONNECTION_REFUSED](-e-r-r-o-r_-c-o-n-n-e-c-t-i-o-n_-r-e-f-u-s-e-d.md) | | +| [ERROR_UNKNOWN_SOCKET_TYPE](-e-r-r-o-r_-u-n-k-n-o-w-n_-s-o-c-k-e-t_-t-y-p-e.md) | | +| [ERROR_REDIRECT_LOOP](-e-r-r-o-r_-r-e-d-i-r-e-c-t_-l-o-o-p.md) | | +| [ERROR_OFFLINE](-e-r-r-o-r_-o-f-f-l-i-n-e.md) | | +| [ERROR_PORT_BLOCKED](-e-r-r-o-r_-p-o-r-t_-b-l-o-c-k-e-d.md) | | +| [ERROR_NET_RESET](-e-r-r-o-r_-n-e-t_-r-e-s-e-t.md) | | +| [ERROR_UNSAFE_CONTENT_TYPE](-e-r-r-o-r_-u-n-s-a-f-e_-c-o-n-t-e-n-t_-t-y-p-e.md) | | +| [ERROR_CORRUPTED_CONTENT](-e-r-r-o-r_-c-o-r-r-u-p-t-e-d_-c-o-n-t-e-n-t.md) | | +| [ERROR_CONTENT_CRASHED](-e-r-r-o-r_-c-o-n-t-e-n-t_-c-r-a-s-h-e-d.md) | | +| [ERROR_INVALID_CONTENT_ENCODING](-e-r-r-o-r_-i-n-v-a-l-i-d_-c-o-n-t-e-n-t_-e-n-c-o-d-i-n-g.md) | | +| [ERROR_UNKNOWN_HOST](-e-r-r-o-r_-u-n-k-n-o-w-n_-h-o-s-t.md) | | +| [ERROR_MALFORMED_URI](-e-r-r-o-r_-m-a-l-f-o-r-m-e-d_-u-r-i.md) | | +| [ERROR_UNKNOWN_PROTOCOL](-e-r-r-o-r_-u-n-k-n-o-w-n_-p-r-o-t-o-c-o-l.md) | | +| [ERROR_FILE_NOT_FOUND](-e-r-r-o-r_-f-i-l-e_-n-o-t_-f-o-u-n-d.md) | | +| [ERROR_FILE_ACCESS_DENIED](-e-r-r-o-r_-f-i-l-e_-a-c-c-e-s-s_-d-e-n-i-e-d.md) | | +| [ERROR_PROXY_CONNECTION_REFUSED](-e-r-r-o-r_-p-r-o-x-y_-c-o-n-n-e-c-t-i-o-n_-r-e-f-u-s-e-d.md) | | +| [ERROR_UNKNOWN_PROXY_HOST](-e-r-r-o-r_-u-n-k-n-o-w-n_-p-r-o-x-y_-h-o-s-t.md) | | +| [ERROR_SAFEBROWSING_MALWARE_URI](-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-m-a-l-w-a-r-e_-u-r-i.md) | | +| [ERROR_SAFEBROWSING_UNWANTED_URI](-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-u-n-w-a-n-t-e-d_-u-r-i.md) | | +| [ERROR_SAFEBROWSING_HARMFUL_URI](-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-h-a-r-m-f-u-l_-u-r-i.md) | | +| [ERROR_SAFEBROWSING_PHISHING_URI](-e-r-r-o-r_-s-a-f-e-b-r-o-w-s-i-n-g_-p-h-i-s-h-i-n-g_-u-r-i.md) | | + +### Properties + +| Name | Summary | +|---|---| +| [messageRes](message-res.md) | `val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [titleRes](title-res.md) | `val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/message-res.md b/docs/api/mozilla.components.browser.errorpages/-error-type/message-res.md new file mode 100644 index 00000000000..68ffd402dc8 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/message-res.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [messageRes](./message-res.md) + +# messageRes + +`val messageRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L43) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.errorpages/-error-type/title-res.md b/docs/api/mozilla.components.browser.errorpages/-error-type/title-res.md new file mode 100644 index 00000000000..64cf451800f --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/-error-type/title-res.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.errorpages](../index.md) / [ErrorType](index.md) / [titleRes](./title-res.md) + +# titleRes + +`val titleRes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/errorpages/src/main/java/mozilla/components/browser/errorpages/ErrorPages.kt#L42) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.errorpages/index.md b/docs/api/mozilla.components.browser.errorpages/index.md new file mode 100644 index 00000000000..24b37c5f617 --- /dev/null +++ b/docs/api/mozilla.components.browser.errorpages/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.browser.errorpages](./index.md) + +## Package mozilla.components.browser.errorpages + +### Types + +| Name | Summary | +|---|---| +| [ErrorPages](-error-pages/index.md) | `object ErrorPages` | +| [ErrorType](-error-type/index.md) | `enum class ErrorType`
Enum containing all supported error types that we can display an error page for. | diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-checkbox/-init-.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-checkbox/-init-.md new file mode 100644 index 00000000000..27a33500389 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-checkbox/-init-.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuCheckbox](index.md) / [<init>](./-init-.md) + +# <init> + +`BrowserMenuCheckbox(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/mozilla.components.browser.menu.item/-browser-menu-checkbox/get-layout-resource.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-checkbox/get-layout-resource.md new file mode 100644 index 00000000000..a74a9e3efbf --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-checkbox/get-layout-resource.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuCheckbox](index.md) / [getLayoutResource](./get-layout-resource.md) + +# getLayoutResource + +`fun getLayoutResource(): ` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuCheckbox.kt#L21) + +Overrides [BrowserMenuItem.getLayoutResource](../../mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md) + +Returns the layout resource ID of the layout to be inflated for showing a menu item of this +type. + diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-checkbox/index.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-checkbox/index.md new file mode 100644 index 00000000000..f5046b37151 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-checkbox/index.md @@ -0,0 +1,39 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuCheckbox](./index.md) + +# BrowserMenuCheckbox + +`class BrowserMenuCheckbox : `[`BrowserMenuCompoundButton`](../-browser-menu-compound-button/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuCheckbox.kt#L16) + +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 + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `BrowserMenuCheckbox(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. | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [visible](../-browser-menu-compound-button/visible.md) | `open 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 + +| Name | Summary | +|---|---| +| [getLayoutResource](get-layout-resource.md) | `fun getLayoutResource(): `
Returns the layout resource ID of the layout to be inflated for showing a menu item of this type. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [bind](../-browser-menu-compound-button/bind.md) | `open fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`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/mozilla.components.browser.menu.item/-browser-menu-compound-button/-init-.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-compound-button/-init-.md new file mode 100644 index 00000000000..3c8e31b7e16 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-compound-button/-init-.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuCompoundButton](index.md) / [<init>](./-init-.md) + +# <init> + +`BrowserMenuCompoundButton(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 browser menu compound button. A basic sub-class would only have to provide a layout resource to +satisfy [BrowserMenuItem.getLayoutResource](../../mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md) which contains a [View](https://developer.android.com/reference/android/view/View.html) that inherits from [CompoundButton](https://developer.android.com/reference/android/widget/CompoundButton.html). + +### 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/mozilla.components.browser.menu.item/-browser-menu-compound-button/bind.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-compound-button/bind.md new file mode 100644 index 00000000000..3d7d791adc8 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-compound-button/bind.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuCompoundButton](index.md) / [bind](./bind.md) + +# bind + +`open fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuCompoundButton.kt#L29) + +Overrides [BrowserMenuItem.bind](../../mozilla.components.browser.menu/-browser-menu-item/bind.md) + +Called by the browser menu to display the data of this item using the passed view. + diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-compound-button/index.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-compound-button/index.md new file mode 100644 index 00000000000..232402c931f --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-compound-button/index.md @@ -0,0 +1,47 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuCompoundButton](./index.md) + +# BrowserMenuCompoundButton + +`abstract class BrowserMenuCompoundButton : `[`BrowserMenuItem`](../../mozilla.components.browser.menu/-browser-menu-item/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuCompoundButton.kt#L22) + +A browser menu compound button. A basic sub-class would only have to provide a layout resource to +satisfy [BrowserMenuItem.getLayoutResource](../../mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md) which contains a [View](https://developer.android.com/reference/android/view/View.html) that inherits from [CompoundButton](https://developer.android.com/reference/android/widget/CompoundButton.html). + +### 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 + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `BrowserMenuCompoundButton(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 browser menu compound button. A basic sub-class would only have to provide a layout resource to satisfy [BrowserMenuItem.getLayoutResource](../../mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md) which contains a [View](https://developer.android.com/reference/android/view/View.html) that inherits from [CompoundButton](https://developer.android.com/reference/android/widget/CompoundButton.html). | + +### Properties + +| Name | Summary | +|---|---| +| [visible](visible.md) | `open 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 + +| Name | Summary | +|---|---| +| [bind](bind.md) | `open fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`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. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getLayoutResource](../../mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md) | `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 + +| Name | Summary | +|---|---| +| [BrowserMenuCheckbox](../-browser-menu-checkbox/index.md) | `class BrowserMenuCheckbox : `[`BrowserMenuCompoundButton`](./index.md)
A simple browser menu checkbox. | +| [BrowserMenuSwitch](../-browser-menu-switch/index.md) | `class BrowserMenuSwitch : `[`BrowserMenuCompoundButton`](./index.md)
A simple browser menu switch. | diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-compound-button/visible.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-compound-button/visible.md new file mode 100644 index 00000000000..2d9b8f8015e --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-compound-button/visible.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuCompoundButton](index.md) / [visible](./visible.md) + +# visible + +`open var visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuCompoundButton.kt#L27) + +Overrides [BrowserMenuItem.visible](../../mozilla.components.browser.menu/-browser-menu-item/visible.md) + +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/mozilla.components.browser.menu.item/-browser-menu-divider/-init-.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/-init-.md new file mode 100644 index 00000000000..0ccfb87d313 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuDivider](index.md) / [<init>](./-init-.md) + +# <init> + +`BrowserMenuDivider()` + +A browser menu item to display a horizontal divider. + diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/bind.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/bind.md new file mode 100644 index 00000000000..025de0a52e7 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/bind.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuDivider](index.md) / [bind](./bind.md) + +# bind + +`fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuDivider.kt#L20) + +Overrides [BrowserMenuItem.bind](../../mozilla.components.browser.menu/-browser-menu-item/bind.md) + +Called by the browser menu to display the data of this item using the passed view. + diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/get-layout-resource.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/get-layout-resource.md new file mode 100644 index 00000000000..abcbaf275ff --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/get-layout-resource.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuDivider](index.md) / [getLayoutResource](./get-layout-resource.md) + +# getLayoutResource + +`fun getLayoutResource(): ` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuDivider.kt#L18) + +Overrides [BrowserMenuItem.getLayoutResource](../../mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md) + +Returns the layout resource ID of the layout to be inflated for showing a menu item of this +type. + diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/index.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/index.md new file mode 100644 index 00000000000..494e10af9f8 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/index.md @@ -0,0 +1,26 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuDivider](./index.md) + +# BrowserMenuDivider + +`class BrowserMenuDivider : `[`BrowserMenuItem`](../../mozilla.components.browser.menu/-browser-menu-item/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuDivider.kt#L15) + +A browser menu item to display a horizontal divider. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `BrowserMenuDivider()`
A browser menu item to display a horizontal divider. | + +### Properties + +| Name | Summary | +|---|---| +| [visible](visible.md) | `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 + +| Name | Summary | +|---|---| +| [bind](bind.md) | `fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`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.md) | `fun getLayoutResource(): `
Returns the layout resource ID of the layout to be inflated for showing a menu item of this type. | diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/visible.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/visible.md new file mode 100644 index 00000000000..37c03542a3c --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-divider/visible.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuDivider](index.md) / [visible](./visible.md) + +# visible + +`var visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuDivider.kt#L16) + +Overrides [BrowserMenuItem.visible](../../mozilla.components.browser.menu/-browser-menu-item/visible.md) + +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/mozilla.components.browser.menu.item/-browser-menu-image-text/-init-.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/-init-.md new file mode 100644 index 00000000000..80fa4a3abec --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/-init-.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuImageText](index.md) / [<init>](./-init-.md) + +# <init> + +`BrowserMenuImageText(label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, @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)`, @ColorRes iconTintColorResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = NO_ID, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = {})` + +A menu item for displaying text with an image icon. + +### Parameters + +`label` - The visible label of this menu item. + +`imageResource` - ID of a drawable resource to be shown as icon. + +`contentDescription` - The image's content description, used for accessibility support. + +`iconTintColorResource` - Optional ID of color resource to tint the icon. + +`listener` - Callback to be invoked when this menu item is clicked. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/bind.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/bind.md new file mode 100644 index 00000000000..f53cd6aea55 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/bind.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuImageText](index.md) / [bind](./bind.md) + +# bind + +`fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuImageText.kt#L42) + +Overrides [BrowserMenuItem.bind](../../mozilla.components.browser.menu/-browser-menu-item/bind.md) + +Called by the browser menu to display the data of this item using the passed view. + diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/get-layout-resource.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/get-layout-resource.md new file mode 100644 index 00000000000..da097c2476b --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/get-layout-resource.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuImageText](index.md) / [getLayoutResource](./get-layout-resource.md) + +# getLayoutResource + +`fun getLayoutResource(): ` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuImageText.kt#L40) + +Overrides [BrowserMenuItem.getLayoutResource](../../mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md) + +Returns the layout resource ID of the layout to be inflated for showing a menu item of this +type. + diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/index.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/index.md new file mode 100644 index 00000000000..f6de6a39519 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/index.md @@ -0,0 +1,38 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuImageText](./index.md) + +# BrowserMenuImageText + +`class BrowserMenuImageText : `[`BrowserMenuItem`](../../mozilla.components.browser.menu/-browser-menu-item/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuImageText.kt#L28) + +A menu item for displaying text with an image icon. + +### Parameters + +`label` - The visible label of this menu item. + +`imageResource` - ID of a drawable resource to be shown as icon. + +`contentDescription` - The image's content description, used for accessibility support. + +`iconTintColorResource` - Optional ID of color resource to tint the icon. + +`listener` - Callback to be invoked when this menu item is clicked. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `BrowserMenuImageText(label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, 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)` = NO_ID, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = {})`
A menu item for displaying text with an image icon. | + +### Properties + +| Name | Summary | +|---|---| +| [visible](visible.md) | `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 + +| Name | Summary | +|---|---| +| [bind](bind.md) | `fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`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.md) | `fun getLayoutResource(): `
Returns the layout resource ID of the layout to be inflated for showing a menu item of this type. | diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/visible.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/visible.md new file mode 100644 index 00000000000..503876177d1 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-image-text/visible.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuImageText](index.md) / [visible](./visible.md) + +# visible + +`var visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuImageText.kt#L38) + +Overrides [BrowserMenuItem.visible](../../mozilla.components.browser.menu/-browser-menu-item/visible.md) + +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/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/-init-.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/-init-.md new file mode 100644 index 00000000000..26674532700 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/-init-.md @@ -0,0 +1,17 @@ +[android-components](../../../index.md) / [mozilla.components.browser.menu.item](../../index.md) / [BrowserMenuItemToolbar](../index.md) / [Button](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/content-description.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/content-description.md new file mode 100644 index 00000000000..c1cae1fb5c6 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/content-description.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.menu.item](../../index.md) / [BrowserMenuItemToolbar](../index.md) / [Button](index.md) / [contentDescription](./content-description.md) + +# contentDescription + +`val contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuItemToolbar.kt#L67) + +The button's content description, used for accessibility support. + diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/icon-tint-color-resource.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/icon-tint-color-resource.md new file mode 100644 index 00000000000..55e96ca59f9 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/icon-tint-color-resource.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.menu.item](../../index.md) / [BrowserMenuItemToolbar](../index.md) / [Button](index.md) / [iconTintColorResource](./icon-tint-color-resource.md) + +# iconTintColorResource + +`val iconTintColorResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuItemToolbar.kt#L68) + +Optional ID of color resource to tint the icon. + diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/image-resource.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/image-resource.md new file mode 100644 index 00000000000..5636999cbfe --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/image-resource.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.menu.item](../../index.md) / [BrowserMenuItemToolbar](../index.md) / [Button](index.md) / [imageResource](./image-resource.md) + +# imageResource + +`val imageResource: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuItemToolbar.kt#L66) + +ID of a drawable resource to be shown as icon. + diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/index.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/index.md new file mode 100644 index 00000000000..8587b4d98d8 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/index.md @@ -0,0 +1,32 @@ +[android-components](../../../index.md) / [mozilla.components.browser.menu.item](../../index.md) / [BrowserMenuItemToolbar](../index.md) / [Button](./index.md) + +# Button + +`class Button` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuItemToolbar.kt#L65) + +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 + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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 + +| Name | Summary | +|---|---| +| [contentDescription](content-description.md) | `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.md) | `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.md) | `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.md) | `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/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/listener.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/listener.md new file mode 100644 index 00000000000..65a5ba3371f --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-button/listener.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.menu.item](../../index.md) / [BrowserMenuItemToolbar](../index.md) / [Button](index.md) / [listener](./listener.md) + +# listener + +`val listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuItemToolbar.kt#L69) + +Callback to be invoked when the button is pressed. + diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-init-.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-init-.md new file mode 100644 index 00000000000..88e3d395181 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuItemToolbar](index.md) / [<init>](./-init-.md) + +# <init> + +`BrowserMenuItemToolbar(items: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Button`](-button/index.md)`>)` + +A toolbar of buttons to show inside the browser menu. + diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/bind.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/bind.md new file mode 100644 index 00000000000..0d52d6ee5cf --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/bind.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuItemToolbar](index.md) / [bind](./bind.md) + +# bind + +`fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuItemToolbar.kt#L27) + +Overrides [BrowserMenuItem.bind](../../mozilla.components.browser.menu/-browser-menu-item/bind.md) + +Called by the browser menu to display the data of this item using the passed view. + diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/get-layout-resource.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/get-layout-resource.md new file mode 100644 index 00000000000..e675b8508de --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/get-layout-resource.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuItemToolbar](index.md) / [getLayoutResource](./get-layout-resource.md) + +# getLayoutResource + +`fun getLayoutResource(): ` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuItemToolbar.kt#L25) + +Overrides [BrowserMenuItem.getLayoutResource](../../mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md) + +Returns the layout resource ID of the layout to be inflated for showing a menu item of this +type. + diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/index.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/index.md new file mode 100644 index 00000000000..2cb5b0db2fe --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/index.md @@ -0,0 +1,32 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuItemToolbar](./index.md) + +# BrowserMenuItemToolbar + +`class BrowserMenuItemToolbar : `[`BrowserMenuItem`](../../mozilla.components.browser.menu/-browser-menu-item/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuItemToolbar.kt#L20) + +A toolbar of buttons to show inside the browser menu. + +### Types + +| Name | Summary | +|---|---| +| [Button](-button/index.md) | `class Button`
A button to be shown in a toolbar inside the browser menu. | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `BrowserMenuItemToolbar(items: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Button`](-button/index.md)`>)`
A toolbar of buttons to show inside the browser menu. | + +### Properties + +| Name | Summary | +|---|---| +| [visible](visible.md) | `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 + +| Name | Summary | +|---|---| +| [bind](bind.md) | `fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`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.md) | `fun getLayoutResource(): `
Returns the layout resource ID of the layout to be inflated for showing a menu item of this type. | diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/visible.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/visible.md new file mode 100644 index 00000000000..12c6427ddcc --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-item-toolbar/visible.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuItemToolbar](index.md) / [visible](./visible.md) + +# visible + +`var visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuItemToolbar.kt#L23) + +Overrides [BrowserMenuItem.visible](../../mozilla.components.browser.menu/-browser-menu-item/visible.md) + +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/mozilla.components.browser.menu.item/-browser-menu-switch/-init-.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-switch/-init-.md new file mode 100644 index 00000000000..335375852ce --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-switch/-init-.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuSwitch](index.md) / [<init>](./-init-.md) + +# <init> + +`BrowserMenuSwitch(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 switch. + +### 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/mozilla.components.browser.menu.item/-browser-menu-switch/get-layout-resource.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-switch/get-layout-resource.md new file mode 100644 index 00000000000..63debe52282 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-switch/get-layout-resource.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuSwitch](index.md) / [getLayoutResource](./get-layout-resource.md) + +# getLayoutResource + +`fun getLayoutResource(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuSwitch.kt#L23) + +Overrides [BrowserMenuItem.getLayoutResource](../../mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md) + +Returns the layout resource ID of the layout to be inflated for showing a menu item of this +type. + diff --git a/docs/api/mozilla.components.browser.menu.item/-browser-menu-switch/index.md b/docs/api/mozilla.components.browser.menu.item/-browser-menu-switch/index.md new file mode 100644 index 00000000000..b70c0a160c8 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-browser-menu-switch/index.md @@ -0,0 +1,39 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [BrowserMenuSwitch](./index.md) + +# BrowserMenuSwitch + +`class BrowserMenuSwitch : `[`BrowserMenuCompoundButton`](../-browser-menu-compound-button/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/BrowserMenuSwitch.kt#L18) + +A simple browser menu switch. + +### 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 + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `BrowserMenuSwitch(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 switch. | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [visible](../-browser-menu-compound-button/visible.md) | `open 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 + +| Name | Summary | +|---|---| +| [getLayoutResource](get-layout-resource.md) | `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. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [bind](../-browser-menu-compound-button/bind.md) | `open fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`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/mozilla.components.browser.menu.item/-simple-browser-menu-item/-init-.md b/docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/-init-.md new file mode 100644 index 00000000000..8bdb259bbfa --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/-init-.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [SimpleBrowserMenuItem](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.browser.menu.item/-simple-browser-menu-item/bind.md b/docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/bind.md new file mode 100644 index 00000000000..43555f33150 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/bind.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [SimpleBrowserMenuItem](index.md) / [bind](./bind.md) + +# bind + +`fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/SimpleBrowserMenuItem.kt#L27) + +Overrides [BrowserMenuItem.bind](../../mozilla.components.browser.menu/-browser-menu-item/bind.md) + +Called by the browser menu to display the data of this item using the passed view. + diff --git a/docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/get-layout-resource.md b/docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/get-layout-resource.md new file mode 100644 index 00000000000..9ae40c4272f --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/get-layout-resource.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [SimpleBrowserMenuItem](index.md) / [getLayoutResource](./get-layout-resource.md) + +# getLayoutResource + +`fun getLayoutResource(): ` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/SimpleBrowserMenuItem.kt#L25) + +Overrides [BrowserMenuItem.getLayoutResource](../../mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md) + +Returns the layout resource ID of the layout to be inflated for showing a menu item of this +type. + diff --git a/docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/index.md b/docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/index.md new file mode 100644 index 00000000000..2a5f074805b --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/index.md @@ -0,0 +1,32 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [SimpleBrowserMenuItem](./index.md) + +# SimpleBrowserMenuItem + +`class SimpleBrowserMenuItem : `[`BrowserMenuItem`](../../mozilla.components.browser.menu/-browser-menu-item/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/SimpleBrowserMenuItem.kt#L19) + +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 + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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 + +| Name | Summary | +|---|---| +| [visible](visible.md) | `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 + +| Name | Summary | +|---|---| +| [bind](bind.md) | `fun bind(menu: `[`BrowserMenu`](../../mozilla.components.browser.menu/-browser-menu/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`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.md) | `fun getLayoutResource(): `
Returns the layout resource ID of the layout to be inflated for showing a menu item of this type. | diff --git a/docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/visible.md b/docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/visible.md new file mode 100644 index 00000000000..44d281e7638 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/-simple-browser-menu-item/visible.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu.item](../index.md) / [SimpleBrowserMenuItem](index.md) / [visible](./visible.md) + +# visible + +`var visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/item/SimpleBrowserMenuItem.kt#L23) + +Overrides [BrowserMenuItem.visible](../../mozilla.components.browser.menu/-browser-menu-item/visible.md) + +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/mozilla.components.browser.menu.item/index.md b/docs/api/mozilla.components.browser.menu.item/index.md new file mode 100644 index 00000000000..324d15f6f1a --- /dev/null +++ b/docs/api/mozilla.components.browser.menu.item/index.md @@ -0,0 +1,15 @@ +[android-components](../index.md) / [mozilla.components.browser.menu.item](./index.md) + +## Package mozilla.components.browser.menu.item + +### Types + +| Name | Summary | +|---|---| +| [BrowserMenuCheckbox](-browser-menu-checkbox/index.md) | `class BrowserMenuCheckbox : `[`BrowserMenuCompoundButton`](-browser-menu-compound-button/index.md)
A simple browser menu checkbox. | +| [BrowserMenuCompoundButton](-browser-menu-compound-button/index.md) | `abstract class BrowserMenuCompoundButton : `[`BrowserMenuItem`](../mozilla.components.browser.menu/-browser-menu-item/index.md)
A browser menu compound button. A basic sub-class would only have to provide a layout resource to satisfy [BrowserMenuItem.getLayoutResource](../mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md) which contains a [View](https://developer.android.com/reference/android/view/View.html) that inherits from [CompoundButton](https://developer.android.com/reference/android/widget/CompoundButton.html). | +| [BrowserMenuDivider](-browser-menu-divider/index.md) | `class BrowserMenuDivider : `[`BrowserMenuItem`](../mozilla.components.browser.menu/-browser-menu-item/index.md)
A browser menu item to display a horizontal divider. | +| [BrowserMenuImageText](-browser-menu-image-text/index.md) | `class BrowserMenuImageText : `[`BrowserMenuItem`](../mozilla.components.browser.menu/-browser-menu-item/index.md)
A menu item for displaying text with an image icon. | +| [BrowserMenuItemToolbar](-browser-menu-item-toolbar/index.md) | `class BrowserMenuItemToolbar : `[`BrowserMenuItem`](../mozilla.components.browser.menu/-browser-menu-item/index.md)
A toolbar of buttons to show inside the browser menu. | +| [BrowserMenuSwitch](-browser-menu-switch/index.md) | `class BrowserMenuSwitch : `[`BrowserMenuCompoundButton`](-browser-menu-compound-button/index.md)
A simple browser menu switch. | +| [SimpleBrowserMenuItem](-simple-browser-menu-item/index.md) | `class SimpleBrowserMenuItem : `[`BrowserMenuItem`](../mozilla.components.browser.menu/-browser-menu-item/index.md)
A simple browser menu item displaying text. | diff --git a/docs/api/mozilla.components.browser.menu/-browser-menu-builder/-init-.md b/docs/api/mozilla.components.browser.menu/-browser-menu-builder/-init-.md new file mode 100644 index 00000000000..fa92e16880d --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/-browser-menu-builder/-init-.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu](../index.md) / [BrowserMenuBuilder](index.md) / [<init>](./-init-.md) + +# <init> + +`BrowserMenuBuilder(items: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`BrowserMenuItem`](../-browser-menu-item/index.md)`>)` + +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/mozilla.components.browser.menu/-browser-menu-builder/build.md b/docs/api/mozilla.components.browser.menu/-browser-menu-builder/build.md new file mode 100644 index 00000000000..443e5f76158 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/-browser-menu-builder/build.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu](../index.md) / [BrowserMenuBuilder](index.md) / [build](./build.md) + +# build + +`fun build(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`BrowserMenu`](../-browser-menu/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenuBuilder.kt#L17) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.menu/-browser-menu-builder/index.md b/docs/api/mozilla.components.browser.menu/-browser-menu-builder/index.md new file mode 100644 index 00000000000..737e717e5e9 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/-browser-menu-builder/index.md @@ -0,0 +1,29 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu](../index.md) / [BrowserMenuBuilder](./index.md) + +# BrowserMenuBuilder + +`class BrowserMenuBuilder` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenuBuilder.kt#L14) + +Helper class for building browser menus. + +### Parameters + +`items` - List of BrowserMenuItem objects to compose the menu from. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `BrowserMenuBuilder(items: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`BrowserMenuItem`](../-browser-menu-item/index.md)`>)`
Helper class for building browser menus. | + +### Properties + +| Name | Summary | +|---|---| +| [items](items.md) | `val items: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`BrowserMenuItem`](../-browser-menu-item/index.md)`>`
List of BrowserMenuItem objects to compose the menu from. | + +### Functions + +| Name | Summary | +|---|---| +| [build](build.md) | `fun build(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`BrowserMenu`](../-browser-menu/index.md) | diff --git a/docs/api/mozilla.components.browser.menu/-browser-menu-builder/items.md b/docs/api/mozilla.components.browser.menu/-browser-menu-builder/items.md new file mode 100644 index 00000000000..89c4b4b6101 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/-browser-menu-builder/items.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu](../index.md) / [BrowserMenuBuilder](index.md) / [items](./items.md) + +# items + +`val items: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`BrowserMenuItem`](../-browser-menu-item/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenuBuilder.kt#L15) + +List of BrowserMenuItem objects to compose the menu from. + diff --git a/docs/api/mozilla.components.browser.menu/-browser-menu-item-view-holder/-init-.md b/docs/api/mozilla.components.browser.menu/-browser-menu-item-view-holder/-init-.md new file mode 100644 index 00000000000..115a67c62aa --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/-browser-menu-item-view-holder/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu](../index.md) / [BrowserMenuItemViewHolder](index.md) / [<init>](./-init-.md) + +# <init> + +`BrowserMenuItemViewHolder(itemView: `[`View`](https://developer.android.com/reference/android/view/View.html)`)` \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.menu/-browser-menu-item-view-holder/index.md b/docs/api/mozilla.components.browser.menu/-browser-menu-item-view-holder/index.md new file mode 100644 index 00000000000..a41f08d7643 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/-browser-menu-item-view-holder/index.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu](../index.md) / [BrowserMenuItemViewHolder](./index.md) + +# BrowserMenuItemViewHolder + +`class BrowserMenuItemViewHolder : ViewHolder` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenuAdapter.kt#L37) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `BrowserMenuItemViewHolder(itemView: `[`View`](https://developer.android.com/reference/android/view/View.html)`)` | diff --git a/docs/api/mozilla.components.browser.menu/-browser-menu-item/bind.md b/docs/api/mozilla.components.browser.menu/-browser-menu-item/bind.md new file mode 100644 index 00000000000..6aea213a180 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/-browser-menu-item/bind.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu](../index.md) / [BrowserMenuItem](index.md) / [bind](./bind.md) + +# bind + +`abstract fun bind(menu: `[`BrowserMenu`](../-browser-menu/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenuItem.kt#L28) + +Called by the browser menu to display the data of this item using the passed view. + diff --git a/docs/api/mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md b/docs/api/mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md new file mode 100644 index 00000000000..4c36d15c705 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/-browser-menu-item/get-layout-resource.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu](../index.md) / [BrowserMenuItem](index.md) / [getLayoutResource](./get-layout-resource.md) + +# getLayoutResource + +`abstract fun getLayoutResource(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenuItem.kt#L23) + +Returns the layout resource ID of the layout to be inflated for showing a menu item of this +type. + diff --git a/docs/api/mozilla.components.browser.menu/-browser-menu-item/index.md b/docs/api/mozilla.components.browser.menu/-browser-menu-item/index.md new file mode 100644 index 00000000000..1912c75d5ce --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/-browser-menu-item/index.md @@ -0,0 +1,30 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu](../index.md) / [BrowserMenuItem](./index.md) + +# BrowserMenuItem + +`interface BrowserMenuItem` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenuItem.kt#L12) + +Interface to be implemented by menu items to be shown in the browser menu. + +### Properties + +| Name | Summary | +|---|---| +| [visible](visible.md) | `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 + +| Name | Summary | +|---|---| +| [bind](bind.md) | `abstract fun bind(menu: `[`BrowserMenu`](../-browser-menu/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`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.md) | `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 + +| Name | Summary | +|---|---| +| [BrowserMenuCompoundButton](../../mozilla.components.browser.menu.item/-browser-menu-compound-button/index.md) | `abstract class BrowserMenuCompoundButton : `[`BrowserMenuItem`](./index.md)
A browser menu compound button. A basic sub-class would only have to provide a layout resource to satisfy [BrowserMenuItem.getLayoutResource](get-layout-resource.md) which contains a [View](https://developer.android.com/reference/android/view/View.html) that inherits from [CompoundButton](https://developer.android.com/reference/android/widget/CompoundButton.html). | +| [BrowserMenuDivider](../../mozilla.components.browser.menu.item/-browser-menu-divider/index.md) | `class BrowserMenuDivider : `[`BrowserMenuItem`](./index.md)
A browser menu item to display a horizontal divider. | +| [BrowserMenuImageText](../../mozilla.components.browser.menu.item/-browser-menu-image-text/index.md) | `class BrowserMenuImageText : `[`BrowserMenuItem`](./index.md)
A menu item for displaying text with an image icon. | +| [BrowserMenuItemToolbar](../../mozilla.components.browser.menu.item/-browser-menu-item-toolbar/index.md) | `class BrowserMenuItemToolbar : `[`BrowserMenuItem`](./index.md)
A toolbar of buttons to show inside the browser menu. | +| [SimpleBrowserMenuItem](../../mozilla.components.browser.menu.item/-simple-browser-menu-item/index.md) | `class SimpleBrowserMenuItem : `[`BrowserMenuItem`](./index.md)
A simple browser menu item displaying text. | diff --git a/docs/api/mozilla.components.browser.menu/-browser-menu-item/visible.md b/docs/api/mozilla.components.browser.menu/-browser-menu-item/visible.md new file mode 100644 index 00000000000..71a05b1dd32 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/-browser-menu-item/visible.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu](../index.md) / [BrowserMenuItem](index.md) / [visible](./visible.md) + +# visible + +`abstract val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenuItem.kt#L17) + +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/mozilla.components.browser.menu/-browser-menu/-orientation/-d-o-w-n.md b/docs/api/mozilla.components.browser.menu/-browser-menu/-orientation/-d-o-w-n.md new file mode 100644 index 00000000000..9de44266388 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/-browser-menu/-orientation/-d-o-w-n.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.menu](../../index.md) / [BrowserMenu](../index.md) / [Orientation](index.md) / [DOWN](./-d-o-w-n.md) + +# DOWN + +`DOWN` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenu.kt#L87) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.menu/-browser-menu/-orientation/-u-p.md b/docs/api/mozilla.components.browser.menu/-browser-menu/-orientation/-u-p.md new file mode 100644 index 00000000000..495f391eaed --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/-browser-menu/-orientation/-u-p.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.menu](../../index.md) / [BrowserMenu](../index.md) / [Orientation](index.md) / [UP](./-u-p.md) + +# UP + +`UP` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenu.kt#L86) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.menu/-browser-menu/-orientation/index.md b/docs/api/mozilla.components.browser.menu/-browser-menu/-orientation/index.md new file mode 100644 index 00000000000..258b38d8d8c --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/-browser-menu/-orientation/index.md @@ -0,0 +1,12 @@ +[android-components](../../../index.md) / [mozilla.components.browser.menu](../../index.md) / [BrowserMenu](../index.md) / [Orientation](./index.md) + +# Orientation + +`enum class Orientation` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenu.kt#L85) + +### Enum Values + +| Name | Summary | +|---|---| +| [UP](-u-p.md) | | +| [DOWN](-d-o-w-n.md) | | diff --git a/docs/api/mozilla.components.browser.menu/-browser-menu/determine-menu-orientation.md b/docs/api/mozilla.components.browser.menu/-browser-menu/determine-menu-orientation.md new file mode 100644 index 00000000000..4fa256f75d3 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/-browser-menu/determine-menu-orientation.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu](../index.md) / [BrowserMenu](index.md) / [determineMenuOrientation](./determine-menu-orientation.md) + +# determineMenuOrientation + +`fun determineMenuOrientation(parent: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Orientation`](-orientation/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenu.kt#L71) + +Determines the orientation to be used for a menu based on the positioning of the [parent](determine-menu-orientation.md#mozilla.components.browser.menu.BrowserMenu.Companion$determineMenuOrientation(android.view.View)/parent) in the layout. + diff --git a/docs/api/mozilla.components.browser.menu/-browser-menu/dismiss.md b/docs/api/mozilla.components.browser.menu/-browser-menu/dismiss.md new file mode 100644 index 00000000000..f85b7cd50de --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/-browser-menu/dismiss.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu](../index.md) / [BrowserMenu](index.md) / [dismiss](./dismiss.md) + +# dismiss + +`fun dismiss(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenu.kt#L61) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.menu/-browser-menu/index.md b/docs/api/mozilla.components.browser.menu/-browser-menu/index.md new file mode 100644 index 00000000000..d2765b03e13 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/-browser-menu/index.md @@ -0,0 +1,26 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu](../index.md) / [BrowserMenu](./index.md) + +# BrowserMenu + +`class BrowserMenu` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenu.kt#L24) + +A popup menu composed of BrowserMenuItem objects. + +### Types + +| Name | Summary | +|---|---| +| [Orientation](-orientation/index.md) | `enum class Orientation` | + +### Functions + +| Name | Summary | +|---|---| +| [dismiss](dismiss.md) | `fun dismiss(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [show](show.md) | `fun show(anchor: `[`View`](https://developer.android.com/reference/android/view/View.html)`, orientation: `[`Orientation`](-orientation/index.md)` = Orientation.DOWN): `[`PopupWindow`](https://developer.android.com/reference/android/widget/PopupWindow.html) | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [determineMenuOrientation](determine-menu-orientation.md) | `fun determineMenuOrientation(parent: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Orientation`](-orientation/index.md)
Determines the orientation to be used for a menu based on the positioning of the [parent](determine-menu-orientation.md#mozilla.components.browser.menu.BrowserMenu.Companion$determineMenuOrientation(android.view.View)/parent) in the layout. | diff --git a/docs/api/mozilla.components.browser.menu/-browser-menu/show.md b/docs/api/mozilla.components.browser.menu/-browser-menu/show.md new file mode 100644 index 00000000000..e2d80039ab0 --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/-browser-menu/show.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.menu](../index.md) / [BrowserMenu](index.md) / [show](./show.md) + +# show + +`fun show(anchor: `[`View`](https://developer.android.com/reference/android/view/View.html)`, orientation: `[`Orientation`](-orientation/index.md)` = Orientation.DOWN): `[`PopupWindow`](https://developer.android.com/reference/android/widget/PopupWindow.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/menu/src/main/java/mozilla/components/browser/menu/BrowserMenu.kt#L30) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.menu/index.md b/docs/api/mozilla.components.browser.menu/index.md new file mode 100644 index 00000000000..e90f19e677c --- /dev/null +++ b/docs/api/mozilla.components.browser.menu/index.md @@ -0,0 +1,12 @@ +[android-components](../index.md) / [mozilla.components.browser.menu](./index.md) + +## Package mozilla.components.browser.menu + +### Types + +| Name | Summary | +|---|---| +| [BrowserMenu](-browser-menu/index.md) | `class BrowserMenu`
A popup menu composed of BrowserMenuItem objects. | +| [BrowserMenuBuilder](-browser-menu-builder/index.md) | `class BrowserMenuBuilder`
Helper class for building browser menus. | +| [BrowserMenuItem](-browser-menu-item/index.md) | `interface BrowserMenuItem`
Interface to be implemented by menu items to be shown in the browser menu. | +| [BrowserMenuItemViewHolder](-browser-menu-item-view-holder/index.md) | `class BrowserMenuItemViewHolder : ViewHolder` | diff --git a/docs/api/mozilla.components.browser.search.provider.filter/-search-engine-filter/filter.md b/docs/api/mozilla.components.browser.search.provider.filter/-search-engine-filter/filter.md new file mode 100644 index 00000000000..0dbd69c8d9e --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider.filter/-search-engine-filter/filter.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider.filter](../index.md) / [SearchEngineFilter](index.md) / [filter](./filter.md) + +# filter + +`abstract fun filter(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, searchEngine: `[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/provider/filter/SearchEngineFilter.kt#L19) + +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/mozilla.components.browser.search.provider.filter/-search-engine-filter/index.md b/docs/api/mozilla.components.browser.search.provider.filter/-search-engine-filter/index.md new file mode 100644 index 00000000000..4fb7cb5a0de --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider.filter/-search-engine-filter/index.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider.filter](../index.md) / [SearchEngineFilter](./index.md) + +# SearchEngineFilter + +`interface SearchEngineFilter` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/provider/filter/SearchEngineFilter.kt#L14) + +Interface for classes that want to filter the list of search engines a SearchEngineProvider +implementation loads. + +### Functions + +| Name | Summary | +|---|---| +| [filter](filter.md) | `abstract fun filter(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, searchEngine: `[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.md)`): `[`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/mozilla.components.browser.search.provider.filter/index.md b/docs/api/mozilla.components.browser.search.provider.filter/index.md new file mode 100644 index 00000000000..0200f60e737 --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider.filter/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.browser.search.provider.filter](./index.md) + +## Package mozilla.components.browser.search.provider.filter + +### Types + +| Name | Summary | +|---|---| +| [SearchEngineFilter](-search-engine-filter/index.md) | `interface SearchEngineFilter`
Interface for classes that want to filter the list of search engines a SearchEngineProvider implementation loads. | diff --git a/docs/api/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/-init-.md b/docs/api/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/-init-.md new file mode 100644 index 00000000000..17ed0331726 --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider.localization](../index.md) / [LocaleSearchLocalizationProvider](index.md) / [<init>](./-init-.md) + +# <init> + +`LocaleSearchLocalizationProvider()` + +LocalizationProvider implementation that only provides the language and country from the system's +default languageTag. + diff --git a/docs/api/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/country.md b/docs/api/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/country.md new file mode 100644 index 00000000000..c83dbff4236 --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/country.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider.localization](../index.md) / [LocaleSearchLocalizationProvider](index.md) / [country](./country.md) + +# country + +`val country: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/provider/localization/LocaleSearchLocalizationProvider.kt#L17) + +Overrides [SearchLocalizationProvider.country](../-search-localization-provider/country.md) + +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/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/index.md b/docs/api/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/index.md new file mode 100644 index 00000000000..928a51ffce4 --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/index.md @@ -0,0 +1,28 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider.localization](../index.md) / [LocaleSearchLocalizationProvider](./index.md) + +# LocaleSearchLocalizationProvider + +`class LocaleSearchLocalizationProvider : `[`SearchLocalizationProvider`](../-search-localization-provider/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/provider/localization/LocaleSearchLocalizationProvider.kt#L13) + +LocalizationProvider implementation that only provides the language and country from the system's +default languageTag. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `LocaleSearchLocalizationProvider()`
LocalizationProvider implementation that only provides the language and country from the system's default languageTag. | + +### Properties + +| Name | Summary | +|---|---| +| [country](country.md) | `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.md) | `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.md) | `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 + +| Name | Summary | +|---|---| +| [languageTag](../-search-localization-provider/language-tag.md) | `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/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/language.md b/docs/api/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/language.md new file mode 100644 index 00000000000..a6ea9d46af6 --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/language.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider.localization](../index.md) / [LocaleSearchLocalizationProvider](index.md) / [language](./language.md) + +# language + +`val language: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/provider/localization/LocaleSearchLocalizationProvider.kt#L14) + +Overrides [SearchLocalizationProvider.language](../-search-localization-provider/language.md) + +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/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/region.md b/docs/api/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/region.md new file mode 100644 index 00000000000..f040064ef6d --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider.localization/-locale-search-localization-provider/region.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider.localization](../index.md) / [LocaleSearchLocalizationProvider](index.md) / [region](./region.md) + +# region + +`val region: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/provider/localization/LocaleSearchLocalizationProvider.kt#L20) + +Overrides [SearchLocalizationProvider.region](../-search-localization-provider/region.md) + +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/mozilla.components.browser.search.provider.localization/-search-localization-provider/-init-.md b/docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/-init-.md new file mode 100644 index 00000000000..261dd79f33a --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider.localization](../index.md) / [SearchLocalizationProvider](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.browser.search.provider.localization/-search-localization-provider/country.md b/docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/country.md new file mode 100644 index 00000000000..46e2df8083a --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/country.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider.localization](../index.md) / [SearchLocalizationProvider](index.md) / [country](./country.md) + +# country + +`abstract val country: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/provider/localization/SearchLocalizationProvider.kt#L25) + +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/mozilla.components.browser.search.provider.localization/-search-localization-provider/index.md b/docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/index.md new file mode 100644 index 00000000000..a2e75167c62 --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/index.md @@ -0,0 +1,29 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider.localization](../index.md) / [SearchLocalizationProvider](./index.md) + +# SearchLocalizationProvider + +`abstract class SearchLocalizationProvider` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/provider/localization/SearchLocalizationProvider.kt#L11) + +Class providing language, country and optionally region (actual location) of the user/device to +customize the search experience. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SearchLocalizationProvider()`
Class providing language, country and optionally region (actual location) of the user/device to customize the search experience. | + +### Properties + +| Name | Summary | +|---|---| +| [country](country.md) | `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.md) | `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.md) | `val languageTag: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Returns a language tag of the form -. | +| [region](region.md) | `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 + +| Name | Summary | +|---|---| +| [LocaleSearchLocalizationProvider](../-locale-search-localization-provider/index.md) | `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/mozilla.components.browser.search.provider.localization/-search-localization-provider/language-tag.md b/docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/language-tag.md new file mode 100644 index 00000000000..ad3c6046cd4 --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/language-tag.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider.localization](../index.md) / [SearchLocalizationProvider](index.md) / [languageTag](./language-tag.md) + +# languageTag + +`val languageTag: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/provider/localization/SearchLocalizationProvider.kt#L44) + +Returns a language tag of the form -. + +Example: "en-US" (English, United States) + diff --git a/docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/language.md b/docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/language.md new file mode 100644 index 00000000000..a7097340cd3 --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/language.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider.localization](../index.md) / [SearchLocalizationProvider](index.md) / [language](./language.md) + +# language + +`abstract val language: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/provider/localization/SearchLocalizationProvider.kt#L18) + +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/mozilla.components.browser.search.provider.localization/-search-localization-provider/region.md b/docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/region.md new file mode 100644 index 00000000000..cd12fa0210a --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider.localization/-search-localization-provider/region.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider.localization](../index.md) / [SearchLocalizationProvider](index.md) / [region](./region.md) + +# region + +`abstract val region: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/provider/localization/SearchLocalizationProvider.kt#L37) + +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/mozilla.components.browser.search.provider.localization/index.md b/docs/api/mozilla.components.browser.search.provider.localization/index.md new file mode 100644 index 00000000000..edff5d962c1 --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider.localization/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.browser.search.provider.localization](./index.md) + +## Package mozilla.components.browser.search.provider.localization + +### Types + +| Name | Summary | +|---|---| +| [LocaleSearchLocalizationProvider](-locale-search-localization-provider/index.md) | `class LocaleSearchLocalizationProvider : `[`SearchLocalizationProvider`](-search-localization-provider/index.md)
LocalizationProvider implementation that only provides the language and country from the system's default languageTag. | +| [SearchLocalizationProvider](-search-localization-provider/index.md) | `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/mozilla.components.browser.search.provider/-assets-search-engine-provider/-init-.md b/docs/api/mozilla.components.browser.search.provider/-assets-search-engine-provider/-init-.md new file mode 100644 index 00000000000..dc5ad8c69f6 --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider/-assets-search-engine-provider/-init-.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider](../index.md) / [AssetsSearchEngineProvider](index.md) / [<init>](./-init-.md) + +# <init> + +`AssetsSearchEngineProvider(localizationProvider: `[`SearchLocalizationProvider`](../../mozilla.components.browser.search.provider.localization/-search-localization-provider/index.md)`, 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.md)`> = 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/mozilla.components.browser.search.provider/-assets-search-engine-provider/index.md b/docs/api/mozilla.components.browser.search.provider/-assets-search-engine-provider/index.md new file mode 100644 index 00000000000..a4d373fa8fb --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider/-assets-search-engine-provider/index.md @@ -0,0 +1,28 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider](../index.md) / [AssetsSearchEngineProvider](./index.md) + +# AssetsSearchEngineProvider + +`class AssetsSearchEngineProvider : `[`SearchEngineProvider`](../-search-engine-provider/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/provider/AssetsSearchEngineProvider.kt#L33) + +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 + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AssetsSearchEngineProvider(localizationProvider: `[`SearchLocalizationProvider`](../../mozilla.components.browser.search.provider.localization/-search-localization-provider/index.md)`, 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.md)`> = 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 + +| Name | Summary | +|---|---| +| [loadSearchEngines](load-search-engines.md) | `suspend fun loadSearchEngines(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.md)`>`
Load search engines from this provider. | diff --git a/docs/api/mozilla.components.browser.search.provider/-assets-search-engine-provider/load-search-engines.md b/docs/api/mozilla.components.browser.search.provider/-assets-search-engine-provider/load-search-engines.md new file mode 100644 index 00000000000..d493493b2d6 --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider/-assets-search-engine-provider/load-search-engines.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider](../index.md) / [AssetsSearchEngineProvider](index.md) / [loadSearchEngines](./load-search-engines.md) + +# loadSearchEngines + +`suspend fun loadSearchEngines(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/provider/AssetsSearchEngineProvider.kt#L43) + +Overrides [SearchEngineProvider.loadSearchEngines](../-search-engine-provider/load-search-engines.md) + +Load search engines from this provider. + diff --git a/docs/api/mozilla.components.browser.search.provider/-search-engine-provider/index.md b/docs/api/mozilla.components.browser.search.provider/-search-engine-provider/index.md new file mode 100644 index 00000000000..2513c88016c --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider/-search-engine-provider/index.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider](../index.md) / [SearchEngineProvider](./index.md) + +# SearchEngineProvider + +`interface SearchEngineProvider` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/provider/SearchEngineProvider.kt#L13) + +Interface for classes that load search engines from a specific source. + +### Functions + +| Name | Summary | +|---|---| +| [loadSearchEngines](load-search-engines.md) | `abstract suspend fun loadSearchEngines(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.md)`>`
Load search engines from this provider. | + +### Inheritors + +| Name | Summary | +|---|---| +| [AssetsSearchEngineProvider](../-assets-search-engine-provider/index.md) | `class AssetsSearchEngineProvider : `[`SearchEngineProvider`](./index.md)
SearchEngineProvider implementation to load the included search engines from assets. | diff --git a/docs/api/mozilla.components.browser.search.provider/-search-engine-provider/load-search-engines.md b/docs/api/mozilla.components.browser.search.provider/-search-engine-provider/load-search-engines.md new file mode 100644 index 00000000000..0392fc53e2a --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider/-search-engine-provider/load-search-engines.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.provider](../index.md) / [SearchEngineProvider](index.md) / [loadSearchEngines](./load-search-engines.md) + +# loadSearchEngines + +`abstract suspend fun loadSearchEngines(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/provider/SearchEngineProvider.kt#L17) + +Load search engines from this provider. + diff --git a/docs/api/mozilla.components.browser.search.provider/index.md b/docs/api/mozilla.components.browser.search.provider/index.md new file mode 100644 index 00000000000..76ff8fd0a8d --- /dev/null +++ b/docs/api/mozilla.components.browser.search.provider/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.browser.search.provider](./index.md) + +## Package mozilla.components.browser.search.provider + +### Types + +| Name | Summary | +|---|---| +| [AssetsSearchEngineProvider](-assets-search-engine-provider/index.md) | `class AssetsSearchEngineProvider : `[`SearchEngineProvider`](-search-engine-provider/index.md)
SearchEngineProvider implementation to load the included search engines from assets. | +| [SearchEngineProvider](-search-engine-provider/index.md) | `interface SearchEngineProvider`
Interface for classes that load search engines from a specific source. | diff --git a/docs/api/mozilla.components.browser.search.suggestions/-j-s-o-n-response.md b/docs/api/mozilla.components.browser.search.suggestions/-j-s-o-n-response.md new file mode 100644 index 00000000000..7713fc8c67c --- /dev/null +++ b/docs/api/mozilla.components.browser.search.suggestions/-j-s-o-n-response.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.browser.search.suggestions](index.md) / [JSONResponse](./-j-s-o-n-response.md) + +# JSONResponse + +`typealias JSONResponse = `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/suggestions/Parser.kt#L16) + +The Parser is a function that takes a JSON Response and maps +it to a Suggestion list. + diff --git a/docs/api/mozilla.components.browser.search.suggestions/-response-parser.md b/docs/api/mozilla.components.browser.search.suggestions/-response-parser.md new file mode 100644 index 00000000000..7b74bfa44ca --- /dev/null +++ b/docs/api/mozilla.components.browser.search.suggestions/-response-parser.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.browser.search.suggestions](index.md) / [ResponseParser](./-response-parser.md) + +# ResponseParser + +`typealias ResponseParser = (`[`JSONResponse`](-j-s-o-n-response.md)`) -> `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/suggestions/Parser.kt#L17) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-fetch-exception/-init-.md b/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-fetch-exception/-init-.md new file mode 100644 index 00000000000..0bbbf108179 --- /dev/null +++ b/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-fetch-exception/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.search.suggestions](../../index.md) / [SearchSuggestionClient](../index.md) / [FetchException](index.md) / [<init>](./-init-.md) + +# <init> + +`FetchException()` + +Exception types for errors caught while getting a list of suggestions + diff --git a/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-fetch-exception/index.md b/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-fetch-exception/index.md new file mode 100644 index 00000000000..48ab5050f78 --- /dev/null +++ b/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-fetch-exception/index.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.browser.search.suggestions](../../index.md) / [SearchSuggestionClient](../index.md) / [FetchException](./index.md) + +# FetchException + +`class FetchException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/suggestions/SearchSuggestionClient.kt#L27) + +Exception types for errors caught while getting a list of suggestions + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FetchException()`
Exception types for errors caught while getting a list of suggestions | diff --git a/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-init-.md b/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-init-.md new file mode 100644 index 00000000000..decae589345 --- /dev/null +++ b/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.suggestions](../index.md) / [SearchSuggestionClient](index.md) / [<init>](./-init-.md) + +# <init> + +`SearchSuggestionClient(searchEngine: `[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.md)`, fetcher: `[`SearchSuggestionFetcher`](../-search-suggestion-fetcher.md)`)` + +Provides an interface to get search suggestions from a given SearchEngine. + diff --git a/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-response-parser-exception/-init-.md b/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-response-parser-exception/-init-.md new file mode 100644 index 00000000000..dd24fbd052c --- /dev/null +++ b/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-response-parser-exception/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.search.suggestions](../../index.md) / [SearchSuggestionClient](../index.md) / [ResponseParserException](index.md) / [<init>](./-init-.md) + +# <init> + +`ResponseParserException()` \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-response-parser-exception/index.md b/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-response-parser-exception/index.md new file mode 100644 index 00000000000..b41ffecb227 --- /dev/null +++ b/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/-response-parser-exception/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.browser.search.suggestions](../../index.md) / [SearchSuggestionClient](../index.md) / [ResponseParserException](./index.md) + +# ResponseParserException + +`class ResponseParserException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/suggestions/SearchSuggestionClient.kt#L28) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ResponseParserException()` | diff --git a/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/get-suggestions.md b/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/get-suggestions.md new file mode 100644 index 00000000000..ec2f788dd0c --- /dev/null +++ b/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/get-suggestions.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.suggestions](../index.md) / [SearchSuggestionClient](index.md) / [getSuggestions](./get-suggestions.md) + +# 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)`>?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/suggestions/SearchSuggestionClient.kt#L39) + +Gets search suggestions for a given query + diff --git a/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/index.md b/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/index.md new file mode 100644 index 00000000000..dd469999a5f --- /dev/null +++ b/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-client/index.md @@ -0,0 +1,26 @@ +[android-components](../../index.md) / [mozilla.components.browser.search.suggestions](../index.md) / [SearchSuggestionClient](./index.md) + +# SearchSuggestionClient + +`class SearchSuggestionClient` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/suggestions/SearchSuggestionClient.kt#L19) + +Provides an interface to get search suggestions from a given SearchEngine. + +### Exceptions + +| Name | Summary | +|---|---| +| [FetchException](-fetch-exception/index.md) | `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.md) | `class ResponseParserException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SearchSuggestionClient(searchEngine: `[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.md)`, fetcher: `[`SearchSuggestionFetcher`](../-search-suggestion-fetcher.md)`)`
Provides an interface to get search suggestions from a given SearchEngine. | + +### Functions + +| Name | Summary | +|---|---| +| [getSuggestions](get-suggestions.md) | `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/mozilla.components.browser.search.suggestions/-search-suggestion-fetcher.md b/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-fetcher.md new file mode 100644 index 00000000000..f1c5612ce80 --- /dev/null +++ b/docs/api/mozilla.components.browser.search.suggestions/-search-suggestion-fetcher.md @@ -0,0 +1,8 @@ +[android-components](../index.md) / [mozilla.components.browser.search.suggestions](index.md) / [SearchSuggestionFetcher](./-search-suggestion-fetcher.md) + +# 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)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/suggestions/SearchSuggestionClient.kt#L14) + +Async function responsible for taking a URL and returning the results + diff --git a/docs/api/mozilla.components.browser.search.suggestions/index.md b/docs/api/mozilla.components.browser.search.suggestions/index.md new file mode 100644 index 00000000000..a8f9916fefa --- /dev/null +++ b/docs/api/mozilla.components.browser.search.suggestions/index.md @@ -0,0 +1,17 @@ +[android-components](../index.md) / [mozilla.components.browser.search.suggestions](./index.md) + +## Package mozilla.components.browser.search.suggestions + +### Types + +| Name | Summary | +|---|---| +| [SearchSuggestionClient](-search-suggestion-client/index.md) | `class SearchSuggestionClient`
Provides an interface to get search suggestions from a given SearchEngine. | + +### Type Aliases + +| Name | Summary | +|---|---| +| [JSONResponse](-j-s-o-n-response.md) | `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.md) | `typealias ResponseParser = (`[`JSONResponse`](-j-s-o-n-response.md)`) -> `[`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.md) | `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/mozilla.components.browser.search/-search-engine-manager/-init-.md b/docs/api/mozilla.components.browser.search/-search-engine-manager/-init-.md new file mode 100644 index 00000000000..3e948fb4888 --- /dev/null +++ b/docs/api/mozilla.components.browser.search/-search-engine-manager/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.search](../index.md) / [SearchEngineManager](index.md) / [<init>](./-init-.md) + +# <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.md)`> = listOf( + AssetsSearchEngineProvider(LocaleSearchLocalizationProvider())))` + +This class provides access to a centralized registry of search engines. + diff --git a/docs/api/mozilla.components.browser.search/-search-engine-manager/get-default-search-engine.md b/docs/api/mozilla.components.browser.search/-search-engine-manager/get-default-search-engine.md new file mode 100644 index 00000000000..4c5a78112af --- /dev/null +++ b/docs/api/mozilla.components.browser.search/-search-engine-manager/get-default-search-engine.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.browser.search](../index.md) / [SearchEngineManager](index.md) / [getDefaultSearchEngine](./get-default-search-engine.md) + +# getDefaultSearchEngine + +`@Synchronized fun getDefaultSearchEngine(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = EMPTY): `[`SearchEngine`](../-search-engine/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/SearchEngineManager.kt#L65) + +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/mozilla.components.browser.search/-search-engine-manager/get-search-engines.md b/docs/api/mozilla.components.browser.search/-search-engine-manager/get-search-engines.md new file mode 100644 index 00000000000..23578fd2a86 --- /dev/null +++ b/docs/api/mozilla.components.browser.search/-search-engine-manager/get-search-engines.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.search](../index.md) / [SearchEngineManager](index.md) / [getSearchEngines](./get-search-engines.md) + +# getSearchEngines + +`@Synchronized fun getSearchEngines(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngine`](../-search-engine/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/SearchEngineManager.kt#L49) + +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/mozilla.components.browser.search/-search-engine-manager/index.md b/docs/api/mozilla.components.browser.search/-search-engine-manager/index.md new file mode 100644 index 00000000000..c061d9d3bf6 --- /dev/null +++ b/docs/api/mozilla.components.browser.search/-search-engine-manager/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.browser.search](../index.md) / [SearchEngineManager](./index.md) + +# SearchEngineManager + +`class SearchEngineManager` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/SearchEngineManager.kt#L25) + +This class provides access to a centralized registry of search engines. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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.md)`> = listOf( + AssetsSearchEngineProvider(LocaleSearchLocalizationProvider())))`
This class provides access to a centralized registry of search engines. | + +### Functions + +| Name | Summary | +|---|---| +| [getDefaultSearchEngine](get-default-search-engine.md) | `fun getDefaultSearchEngine(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = EMPTY): `[`SearchEngine`](../-search-engine/index.md)
Returns the default search engine. | +| [getSearchEngines](get-search-engines.md) | `fun getSearchEngines(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngine`](../-search-engine/index.md)`>`
Returns all search engines. If no call to load() has been made then calling this method will perform a load. | +| [load](load.md) | `suspend fun load(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): Deferred<`[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngine`](../-search-engine/index.md)`>>`
Asynchronously load search engines from providers. Inherits caller's [CoroutineScope.coroutineContext](#). | +| [registerForLocaleUpdates](register-for-locale-updates.md) | `fun registerForLocaleUpdates(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`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/mozilla.components.browser.search/-search-engine-manager/load.md b/docs/api/mozilla.components.browser.search/-search-engine-manager/load.md new file mode 100644 index 00000000000..87efd3f766e --- /dev/null +++ b/docs/api/mozilla.components.browser.search/-search-engine-manager/load.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.search](../index.md) / [SearchEngineManager](index.md) / [load](./load.md) + +# load + +`@Synchronized suspend fun load(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): Deferred<`[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchEngine`](../-search-engine/index.md)`>>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/SearchEngineManager.kt#L36) + +Asynchronously load search engines from providers. Inherits caller's [CoroutineScope.coroutineContext](#). + diff --git a/docs/api/mozilla.components.browser.search/-search-engine-manager/register-for-locale-updates.md b/docs/api/mozilla.components.browser.search/-search-engine-manager/register-for-locale-updates.md new file mode 100644 index 00000000000..ecd082c662a --- /dev/null +++ b/docs/api/mozilla.components.browser.search/-search-engine-manager/register-for-locale-updates.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.search](../index.md) / [SearchEngineManager](index.md) / [registerForLocaleUpdates](./register-for-locale-updates.md) + +# registerForLocaleUpdates + +`fun registerForLocaleUpdates(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/SearchEngineManager.kt#L78) + +Registers for ACTION_LOCALE_CHANGED broadcasts and automatically reloads the search engines +whenever the locale changes. + diff --git a/docs/api/mozilla.components.browser.search/-search-engine-parser/-init-.md b/docs/api/mozilla.components.browser.search/-search-engine-parser/-init-.md new file mode 100644 index 00000000000..84b57406cd9 --- /dev/null +++ b/docs/api/mozilla.components.browser.search/-search-engine-parser/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.search](../index.md) / [SearchEngineParser](index.md) / [<init>](./-init-.md) + +# <init> + +`SearchEngineParser()` + +A very simple parser for search plugins. + diff --git a/docs/api/mozilla.components.browser.search/-search-engine-parser/index.md b/docs/api/mozilla.components.browser.search/-search-engine-parser/index.md new file mode 100644 index 00000000000..b6f53d8bb76 --- /dev/null +++ b/docs/api/mozilla.components.browser.search/-search-engine-parser/index.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.browser.search](../index.md) / [SearchEngineParser](./index.md) + +# SearchEngineParser + +`class SearchEngineParser` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/SearchEngineParser.kt#L25) + +A very simple parser for search plugins. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SearchEngineParser()`
A very simple parser for search plugins. | + +### Functions + +| Name | Summary | +|---|---| +| [load](load.md) | `fun load(assetManager: `[`AssetManager`](https://developer.android.com/reference/android/content/res/AssetManager.html)`, 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.md)
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`](https://developer.android.com/reference/java/io/InputStream.html)`): `[`SearchEngine`](../-search-engine/index.md)
Loads a SearchEngine from the given stream and assigns it the given identifier. | diff --git a/docs/api/mozilla.components.browser.search/-search-engine-parser/load.md b/docs/api/mozilla.components.browser.search/-search-engine-parser/load.md new file mode 100644 index 00000000000..67c8e8af8dd --- /dev/null +++ b/docs/api/mozilla.components.browser.search/-search-engine-parser/load.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.browser.search](../index.md) / [SearchEngineParser](index.md) / [load](./load.md) + +# load + +`fun load(assetManager: `[`AssetManager`](https://developer.android.com/reference/android/content/res/AssetManager.html)`, 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.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/SearchEngineParser.kt#L49) + +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`](https://developer.android.com/reference/java/io/InputStream.html)`): `[`SearchEngine`](../-search-engine/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/SearchEngineParser.kt#L62) + +Loads a SearchEngine from the given stream and assigns it the given +identifier. + diff --git a/docs/api/mozilla.components.browser.search/-search-engine/build-search-url.md b/docs/api/mozilla.components.browser.search/-search-engine/build-search-url.md new file mode 100644 index 00000000000..827c944a127 --- /dev/null +++ b/docs/api/mozilla.components.browser.search/-search-engine/build-search-url.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.search](../index.md) / [SearchEngine](index.md) / [buildSearchUrl](./build-search-url.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/SearchEngine.kt#L33) + +Builds a URL to search for the given search terms with this search engine. + diff --git a/docs/api/mozilla.components.browser.search/-search-engine/build-suggestions-u-r-l.md b/docs/api/mozilla.components.browser.search/-search-engine/build-suggestions-u-r-l.md new file mode 100644 index 00000000000..09e44f49045 --- /dev/null +++ b/docs/api/mozilla.components.browser.search/-search-engine/build-suggestions-u-r-l.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.search](../index.md) / [SearchEngine](index.md) / [buildSuggestionsURL](./build-suggestions-u-r-l.md) + +# 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)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/SearchEngine.kt#L43) + +Builds a URL to get suggestions from this search engine. + diff --git a/docs/api/mozilla.components.browser.search/-search-engine/can-provide-search-suggestions.md b/docs/api/mozilla.components.browser.search/-search-engine/can-provide-search-suggestions.md new file mode 100644 index 00000000000..6541c13280b --- /dev/null +++ b/docs/api/mozilla.components.browser.search/-search-engine/can-provide-search-suggestions.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.search](../index.md) / [SearchEngine](index.md) / [canProvideSearchSuggestions](./can-provide-search-suggestions.md) + +# canProvideSearchSuggestions + +`val canProvideSearchSuggestions: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/SearchEngine.kt#L22) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.search/-search-engine/icon.md b/docs/api/mozilla.components.browser.search/-search-engine/icon.md new file mode 100644 index 00000000000..f28ee0177a8 --- /dev/null +++ b/docs/api/mozilla.components.browser.search/-search-engine/icon.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.search](../index.md) / [SearchEngine](index.md) / [icon](./icon.md) + +# icon + +`val icon: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/SearchEngine.kt#L18) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.search/-search-engine/identifier.md b/docs/api/mozilla.components.browser.search/-search-engine/identifier.md new file mode 100644 index 00000000000..39da000e68f --- /dev/null +++ b/docs/api/mozilla.components.browser.search/-search-engine/identifier.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.search](../index.md) / [SearchEngine](index.md) / [identifier](./identifier.md) + +# identifier + +`val identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/SearchEngine.kt#L16) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.search/-search-engine/index.md b/docs/api/mozilla.components.browser.search/-search-engine/index.md new file mode 100644 index 00000000000..3bbc005ca58 --- /dev/null +++ b/docs/api/mozilla.components.browser.search/-search-engine/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.browser.search](../index.md) / [SearchEngine](./index.md) + +# SearchEngine + +`class SearchEngine` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/SearchEngine.kt#L15) + +A data class representing a search engine. + +### Properties + +| Name | Summary | +|---|---| +| [canProvideSearchSuggestions](can-provide-search-suggestions.md) | `val canProvideSearchSuggestions: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [icon](icon.md) | `val icon: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html) | +| [identifier](identifier.md) | `val identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [name](name.md) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [buildSearchUrl](build-search-url.md) | `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.md) | `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/mozilla.components.browser.search/-search-engine/name.md b/docs/api/mozilla.components.browser.search/-search-engine/name.md new file mode 100644 index 00000000000..1eca421349c --- /dev/null +++ b/docs/api/mozilla.components.browser.search/-search-engine/name.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.search](../index.md) / [SearchEngine](index.md) / [name](./name.md) + +# name + +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/search/src/main/java/mozilla/components/browser/search/SearchEngine.kt#L17) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.search/index.md b/docs/api/mozilla.components.browser.search/index.md new file mode 100644 index 00000000000..06fd55dc96a --- /dev/null +++ b/docs/api/mozilla.components.browser.search/index.md @@ -0,0 +1,11 @@ +[android-components](../index.md) / [mozilla.components.browser.search](./index.md) + +## Package mozilla.components.browser.search + +### Types + +| Name | Summary | +|---|---| +| [SearchEngine](-search-engine/index.md) | `class SearchEngine`
A data class representing a search engine. | +| [SearchEngineManager](-search-engine-manager/index.md) | `class SearchEngineManager`
This class provides access to a centralized registry of search engines. | +| [SearchEngineParser](-search-engine-parser/index.md) | `class SearchEngineParser`
A very simple parser for search plugins. | diff --git a/docs/api/mozilla.components.browser.session.storage/-auto-save/-d-e-f-a-u-l-t_-i-n-t-e-r-v-a-l_-m-i-l-l-i-s-e-c-o-n-d-s.md b/docs/api/mozilla.components.browser.session.storage/-auto-save/-d-e-f-a-u-l-t_-i-n-t-e-r-v-a-l_-m-i-l-l-i-s-e-c-o-n-d-s.md new file mode 100644 index 00000000000..9a0666cdcd8 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-auto-save/-d-e-f-a-u-l-t_-i-n-t-e-r-v-a-l_-m-i-l-l-i-s-e-c-o-n-d-s.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.storage](../index.md) / [AutoSave](index.md) / [DEFAULT_INTERVAL_MILLISECONDS](./-d-e-f-a-u-l-t_-i-n-t-e-r-v-a-l_-m-i-l-l-i-s-e-c-o-n-d-s.md) + +# DEFAULT_INTERVAL_MILLISECONDS + +`const val DEFAULT_INTERVAL_MILLISECONDS: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/storage/AutoSave.kt#L129) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.storage/-auto-save/-init-.md b/docs/api/mozilla.components.browser.session.storage/-auto-save/-init-.md new file mode 100644 index 00000000000..ca31fadeb15 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-auto-save/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.storage](../index.md) / [AutoSave](index.md) / [<init>](./-init-.md) + +# <init> + +`AutoSave(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, sessionStorage: `[`Storage`](-storage/index.md)`, minimumIntervalMs: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`)` \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.storage/-auto-save/-storage/index.md b/docs/api/mozilla.components.browser.session.storage/-auto-save/-storage/index.md new file mode 100644 index 00000000000..5cb678308bf --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-auto-save/-storage/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session.storage](../../index.md) / [AutoSave](../index.md) / [Storage](./index.md) + +# Storage + +`interface Storage` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/storage/AutoSave.kt#L28) + +### Functions + +| Name | Summary | +|---|---| +| [save](save.md) | `abstract fun save(snapshot: `[`Snapshot`](../../../mozilla.components.browser.session/-session-manager/-snapshot/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [SessionBundleStorage](../../../mozilla.components.feature.session.bundling/-session-bundle-storage/index.md) | `class SessionBundleStorage : `[`Storage`](./index.md)
A [Session](../../../mozilla.components.browser.session/-session/index.md) storage implementation that saves snapshots as a [SessionBundle](../../../mozilla.components.feature.session.bundling/-session-bundle/index.md). | +| [SessionStorage](../../-session-storage/index.md) | `class SessionStorage : `[`Storage`](./index.md)
Session storage for persisting the state of a [SessionManager](../../../mozilla.components.browser.session/-session-manager/index.md) to disk (browser and engine session states). | diff --git a/docs/api/mozilla.components.browser.session.storage/-auto-save/-storage/save.md b/docs/api/mozilla.components.browser.session.storage/-auto-save/-storage/save.md new file mode 100644 index 00000000000..92c0367f896 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-auto-save/-storage/save.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session.storage](../../index.md) / [AutoSave](../index.md) / [Storage](index.md) / [save](./save.md) + +# save + +`abstract fun save(snapshot: `[`Snapshot`](../../../mozilla.components.browser.session/-session-manager/-snapshot/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/storage/AutoSave.kt#L29) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.storage/-auto-save/index.md b/docs/api/mozilla.components.browser.session.storage/-auto-save/index.md new file mode 100644 index 00000000000..2e724094e72 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-auto-save/index.md @@ -0,0 +1,31 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.storage](../index.md) / [AutoSave](./index.md) + +# AutoSave + +`class AutoSave` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/storage/AutoSave.kt#L23) + +### Types + +| Name | Summary | +|---|---| +| [Storage](-storage/index.md) | `interface Storage` | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AutoSave(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, sessionStorage: `[`Storage`](-storage/index.md)`, minimumIntervalMs: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [periodicallyInForeground](periodically-in-foreground.md) | `fun periodicallyInForeground(interval: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = 300, unit: `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)` = TimeUnit.SECONDS, scheduler: `[`ScheduledExecutorService`](https://developer.android.com/reference/java/util/concurrent/ScheduledExecutorService.html)` = Executors.newSingleThreadScheduledExecutor(), lifecycle: Lifecycle = ProcessLifecycleOwner.get().lifecycle): `[`AutoSave`](./index.md)
Saves the state periodically when the app is in the foreground. | +| [whenGoingToBackground](when-going-to-background.md) | `fun whenGoingToBackground(lifecycle: Lifecycle = ProcessLifecycleOwner.get().lifecycle): `[`AutoSave`](./index.md)
Saves the state automatically when the app goes to the background. | +| [whenSessionsChange](when-sessions-change.md) | `fun whenSessionsChange(): `[`AutoSave`](./index.md)
Saves the state automatically when the sessions change, e.g. sessions get added and removed. | + +### Companion Object Properties + +| Name | Summary | +|---|---| +| [DEFAULT_INTERVAL_MILLISECONDS](-d-e-f-a-u-l-t_-i-n-t-e-r-v-a-l_-m-i-l-l-i-s-e-c-o-n-d-s.md) | `const val DEFAULT_INTERVAL_MILLISECONDS: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | diff --git a/docs/api/mozilla.components.browser.session.storage/-auto-save/periodically-in-foreground.md b/docs/api/mozilla.components.browser.session.storage/-auto-save/periodically-in-foreground.md new file mode 100644 index 00000000000..d599a64356a --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-auto-save/periodically-in-foreground.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.storage](../index.md) / [AutoSave](index.md) / [periodicallyInForeground](./periodically-in-foreground.md) + +# periodicallyInForeground + +`fun periodicallyInForeground(interval: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = 300, unit: `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)` = TimeUnit.SECONDS, scheduler: `[`ScheduledExecutorService`](https://developer.android.com/reference/java/util/concurrent/ScheduledExecutorService.html)` = Executors.newSingleThreadScheduledExecutor(), lifecycle: Lifecycle = ProcessLifecycleOwner.get().lifecycle): `[`AutoSave`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/storage/AutoSave.kt#L42) + +Saves the state periodically when the app is in the foreground. + +### Parameters + +`interval` - The interval in which the state should be saved to disk. + +`unit` - The time unit of the [interval](periodically-in-foreground.md#mozilla.components.browser.session.storage.AutoSave$periodicallyInForeground(kotlin.Long, java.util.concurrent.TimeUnit, java.util.concurrent.ScheduledExecutorService, android.arch.lifecycle.Lifecycle)/interval) parameter. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.storage/-auto-save/when-going-to-background.md b/docs/api/mozilla.components.browser.session.storage/-auto-save/when-going-to-background.md new file mode 100644 index 00000000000..9f5e1b4aef3 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-auto-save/when-going-to-background.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.storage](../index.md) / [AutoSave](index.md) / [whenGoingToBackground](./when-going-to-background.md) + +# whenGoingToBackground + +`fun whenGoingToBackground(lifecycle: Lifecycle = ProcessLifecycleOwner.get().lifecycle): `[`AutoSave`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/storage/AutoSave.kt#L62) + +Saves the state automatically when the app goes to the background. + diff --git a/docs/api/mozilla.components.browser.session.storage/-auto-save/when-sessions-change.md b/docs/api/mozilla.components.browser.session.storage/-auto-save/when-sessions-change.md new file mode 100644 index 00000000000..69bd6a66dc0 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-auto-save/when-sessions-change.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.storage](../index.md) / [AutoSave](index.md) / [whenSessionsChange](./when-sessions-change.md) + +# whenSessionsChange + +`fun whenSessionsChange(): `[`AutoSave`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/storage/AutoSave.kt#L72) + +Saves the state automatically when the sessions change, e.g. sessions get added and removed. + diff --git a/docs/api/mozilla.components.browser.session.storage/-session-storage/-init-.md b/docs/api/mozilla.components.browser.session.storage/-session-storage/-init-.md new file mode 100644 index 00000000000..89a934de844 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-session-storage/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.storage](../index.md) / [SessionStorage](index.md) / [<init>](./-init-.md) + +# <init> + +`SessionStorage(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, engine: `[`Engine`](../../mozilla.components.concept.engine/-engine/index.md)`)` + +Session storage for persisting the state of a [SessionManager](../../mozilla.components.browser.session/-session-manager/index.md) to disk (browser and engine session states). + diff --git a/docs/api/mozilla.components.browser.session.storage/-session-storage/auto-save.md b/docs/api/mozilla.components.browser.session.storage/-session-storage/auto-save.md new file mode 100644 index 00000000000..7ddebe7b6cc --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-session-storage/auto-save.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.storage](../index.md) / [SessionStorage](index.md) / [autoSave](./auto-save.md) + +# autoSave + +`@CheckResult fun autoSave(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, interval: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = AutoSave.DEFAULT_INTERVAL_MILLISECONDS, unit: `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)` = TimeUnit.MILLISECONDS): `[`AutoSave`](../-auto-save/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/storage/SessionStorage.kt#L64) + +Starts configuring automatic saving of the state. + diff --git a/docs/api/mozilla.components.browser.session.storage/-session-storage/clear.md b/docs/api/mozilla.components.browser.session.storage/-session-storage/clear.md new file mode 100644 index 00000000000..2aafcc244e2 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-session-storage/clear.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.storage](../index.md) / [SessionStorage](index.md) / [clear](./clear.md) + +# clear + +`fun clear(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/storage/SessionStorage.kt#L43) + +Clears the state saved on disk. + diff --git a/docs/api/mozilla.components.browser.session.storage/-session-storage/index.md b/docs/api/mozilla.components.browser.session.storage/-session-storage/index.md new file mode 100644 index 00000000000..82e1bc423f3 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-session-storage/index.md @@ -0,0 +1,22 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.storage](../index.md) / [SessionStorage](./index.md) + +# SessionStorage + +`class SessionStorage : `[`Storage`](../-auto-save/-storage/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/storage/SessionStorage.kt#L27) + +Session storage for persisting the state of a [SessionManager](../../mozilla.components.browser.session/-session-manager/index.md) to disk (browser and engine session states). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SessionStorage(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, engine: `[`Engine`](../../mozilla.components.concept.engine/-engine/index.md)`)`
Session storage for persisting the state of a [SessionManager](../../mozilla.components.browser.session/-session-manager/index.md) to disk (browser and engine session states). | + +### Functions + +| Name | Summary | +|---|---| +| [autoSave](auto-save.md) | `fun autoSave(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, interval: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = AutoSave.DEFAULT_INTERVAL_MILLISECONDS, unit: `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)` = TimeUnit.MILLISECONDS): `[`AutoSave`](../-auto-save/index.md)
Starts configuring automatic saving of the state. | +| [clear](clear.md) | `fun clear(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Clears the state saved on disk. | +| [restore](restore.md) | `fun restore(): `[`Snapshot`](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md)`?`
Reads the saved state from disk. Returns null if no state was found on disk or if reading the file failed. | +| [save](save.md) | `fun save(snapshot: `[`Snapshot`](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Saves the given state to disk. | diff --git a/docs/api/mozilla.components.browser.session.storage/-session-storage/restore.md b/docs/api/mozilla.components.browser.session.storage/-session-storage/restore.md new file mode 100644 index 00000000000..c80cbf152b6 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-session-storage/restore.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.storage](../index.md) / [SessionStorage](index.md) / [restore](./restore.md) + +# restore + +`fun restore(): `[`Snapshot`](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/storage/SessionStorage.kt#L36) + +Reads the saved state from disk. Returns null if no state was found on disk or if reading the file failed. + diff --git a/docs/api/mozilla.components.browser.session.storage/-session-storage/save.md b/docs/api/mozilla.components.browser.session.storage/-session-storage/save.md new file mode 100644 index 00000000000..89ae1f21232 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-session-storage/save.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.storage](../index.md) / [SessionStorage](index.md) / [save](./save.md) + +# save + +`@WorkerThread fun save(snapshot: `[`Snapshot`](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/storage/SessionStorage.kt#L51) + +Overrides [Storage.save](../-auto-save/-storage/save.md) + +Saves the given state to disk. + diff --git a/docs/api/mozilla.components.browser.session.storage/-snapshot-serializer/-init-.md b/docs/api/mozilla.components.browser.session.storage/-snapshot-serializer/-init-.md new file mode 100644 index 00000000000..a59437208c9 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-snapshot-serializer/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.storage](../index.md) / [SnapshotSerializer](index.md) / [<init>](./-init-.md) + +# <init> + +`SnapshotSerializer()` + +Helper to transform [SessionManager.Snapshot](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md) instances to JSON and back. + diff --git a/docs/api/mozilla.components.browser.session.storage/-snapshot-serializer/from-j-s-o-n.md b/docs/api/mozilla.components.browser.session.storage/-snapshot-serializer/from-j-s-o-n.md new file mode 100644 index 00000000000..69691b025e7 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-snapshot-serializer/from-j-s-o-n.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.storage](../index.md) / [SnapshotSerializer](index.md) / [fromJSON](./from-j-s-o-n.md) + +# fromJSON + +`fun fromJSON(engine: `[`Engine`](../../mozilla.components.concept.engine/-engine/index.md)`, json: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Snapshot`](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/storage/SnapshotSerializer.kt#L47) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.storage/-snapshot-serializer/index.md b/docs/api/mozilla.components.browser.session.storage/-snapshot-serializer/index.md new file mode 100644 index 00000000000..0908014b984 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-snapshot-serializer/index.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.storage](../index.md) / [SnapshotSerializer](./index.md) + +# SnapshotSerializer + +`class SnapshotSerializer` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/storage/SnapshotSerializer.kt#L21) + +Helper to transform [SessionManager.Snapshot](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md) instances to JSON and back. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SnapshotSerializer()`
Helper to transform [SessionManager.Snapshot](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md) instances to JSON and back. | + +### Functions + +| Name | Summary | +|---|---| +| [fromJSON](from-j-s-o-n.md) | `fun fromJSON(engine: `[`Engine`](../../mozilla.components.concept.engine/-engine/index.md)`, json: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Snapshot`](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md) | +| [toJSON](to-j-s-o-n.md) | `fun toJSON(snapshot: `[`Snapshot`](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.browser.session.storage/-snapshot-serializer/to-j-s-o-n.md b/docs/api/mozilla.components.browser.session.storage/-snapshot-serializer/to-j-s-o-n.md new file mode 100644 index 00000000000..87fffbde6e6 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/-snapshot-serializer/to-j-s-o-n.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.storage](../index.md) / [SnapshotSerializer](index.md) / [toJSON](./to-j-s-o-n.md) + +# toJSON + +`fun toJSON(snapshot: `[`Snapshot`](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/storage/SnapshotSerializer.kt#L22) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.storage/index.md b/docs/api/mozilla.components.browser.session.storage/index.md new file mode 100644 index 00000000000..494b425eb17 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.storage/index.md @@ -0,0 +1,11 @@ +[android-components](../index.md) / [mozilla.components.browser.session.storage](./index.md) + +## Package mozilla.components.browser.session.storage + +### Types + +| Name | Summary | +|---|---| +| [AutoSave](-auto-save/index.md) | `class AutoSave` | +| [SessionStorage](-session-storage/index.md) | `class SessionStorage : `[`Storage`](-auto-save/-storage/index.md)
Session storage for persisting the state of a [SessionManager](../mozilla.components.browser.session/-session-manager/index.md) to disk (browser and engine session states). | +| [SnapshotSerializer](-snapshot-serializer/index.md) | `class SnapshotSerializer`
Helper to transform [SessionManager.Snapshot](../mozilla.components.browser.session/-session-manager/-snapshot/index.md) instances to JSON and back. | diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/-init-.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/-init-.md new file mode 100644 index 00000000000..c5e2f39f15b --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabActionButtonConfig](index.md) / [<init>](./-init-.md) + +# <init> + +`CustomTabActionButtonConfig(description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, icon: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`, pendingIntent: `[`PendingIntent`](https://developer.android.com/reference/android/app/PendingIntent.html)`)` \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/description.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/description.md new file mode 100644 index 00000000000..79b29bf460c --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/description.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabActionButtonConfig](index.md) / [description](./description.md) + +# description + +`val description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L196) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/icon.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/icon.md new file mode 100644 index 00000000000..a814d57f3d7 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/icon.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabActionButtonConfig](index.md) / [icon](./icon.md) + +# icon + +`val icon: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L196) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/index.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/index.md new file mode 100644 index 00000000000..3b84b9680ac --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/index.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabActionButtonConfig](./index.md) + +# CustomTabActionButtonConfig + +`data class CustomTabActionButtonConfig` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L196) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `CustomTabActionButtonConfig(description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, icon: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`, pendingIntent: `[`PendingIntent`](https://developer.android.com/reference/android/app/PendingIntent.html)`)` | + +### Properties + +| Name | Summary | +|---|---| +| [description](description.md) | `val description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [icon](icon.md) | `val icon: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html) | +| [pendingIntent](pending-intent.md) | `val pendingIntent: `[`PendingIntent`](https://developer.android.com/reference/android/app/PendingIntent.html) | diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/pending-intent.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/pending-intent.md new file mode 100644 index 00000000000..c8392ec5b0d --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-action-button-config/pending-intent.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabActionButtonConfig](index.md) / [pendingIntent](./pending-intent.md) + +# pendingIntent + +`val pendingIntent: `[`PendingIntent`](https://developer.android.com/reference/android/app/PendingIntent.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L196) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/action-button-config.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/action-button-config.md new file mode 100644 index 00000000000..aef20dc8716 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/action-button-config.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabConfig](index.md) / [actionButtonConfig](./action-button-config.md) + +# actionButtonConfig + +`val actionButtonConfig: `[`CustomTabActionButtonConfig`](../-custom-tab-action-button-config/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L30) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/close-button-icon.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/close-button-icon.md new file mode 100644 index 00000000000..1aaff6a8a6a --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/close-button-icon.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabConfig](index.md) / [closeButtonIcon](./close-button-icon.md) + +# closeButtonIcon + +`val closeButtonIcon: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L28) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/create-from-intent.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/create-from-intent.md new file mode 100644 index 00000000000..e9e963a77c7 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/create-from-intent.md @@ -0,0 +1,18 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabConfig](index.md) / [createFromIntent](./create-from-intent.md) + +# createFromIntent + +`fun createFromIntent(intent: `[`SafeIntent`](../../mozilla.components.support.utils/-safe-intent/index.md)`, displayMetrics: `[`DisplayMetrics`](https://developer.android.com/reference/android/util/DisplayMetrics.html)`? = null): `[`CustomTabConfig`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L88) + +Creates a CustomTabConfig instance based on the provided intent. + +### Parameters + +`intent` - the intent, wrapped as a SafeIntent, which is processed +to extract configuration data. + +`displayMetrics` - needed in-order to verify that icons of a max size are only provided. + +**Return** +the CustomTabConfig instance. + diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/disable-urlbar-hiding.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/disable-urlbar-hiding.md new file mode 100644 index 00000000000..dd7cdb78d7e --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/disable-urlbar-hiding.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabConfig](index.md) / [disableUrlbarHiding](./disable-urlbar-hiding.md) + +# disableUrlbarHiding + +`val disableUrlbarHiding: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L29) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/id.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/id.md new file mode 100644 index 00000000000..17460c8e416 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/id.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabConfig](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L26) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/index.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/index.md new file mode 100644 index 00000000000..67a9dc8ef9e --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/index.md @@ -0,0 +1,28 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabConfig](./index.md) + +# CustomTabConfig + +`class CustomTabConfig` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L25) + +Holds configuration data for a Custom Tab. Use [createFromIntent](create-from-intent.md) to +create instances. + +### Properties + +| Name | Summary | +|---|---| +| [actionButtonConfig](action-button-config.md) | `val actionButtonConfig: `[`CustomTabActionButtonConfig`](../-custom-tab-action-button-config/index.md)`?` | +| [closeButtonIcon](close-button-icon.md) | `val closeButtonIcon: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?` | +| [disableUrlbarHiding](disable-urlbar-hiding.md) | `val disableUrlbarHiding: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [menuItems](menu-items.md) | `val menuItems: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`CustomTabMenuItem`](../-custom-tab-menu-item/index.md)`>` | +| [options](options.md) | `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.md) | `val showShareMenuItem: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [toolbarColor](toolbar-color.md) | `val toolbarColor: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?` | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [createFromIntent](create-from-intent.md) | `fun createFromIntent(intent: `[`SafeIntent`](../../mozilla.components.support.utils/-safe-intent/index.md)`, displayMetrics: `[`DisplayMetrics`](https://developer.android.com/reference/android/util/DisplayMetrics.html)`? = null): `[`CustomTabConfig`](./index.md)
Creates a CustomTabConfig instance based on the provided intent. | +| [isCustomTabIntent](is-custom-tab-intent.md) | `fun isCustomTabIntent(intent: `[`SafeIntent`](../../mozilla.components.support.utils/-safe-intent/index.md)`): `[`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/mozilla.components.browser.session.tab/-custom-tab-config/is-custom-tab-intent.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/is-custom-tab-intent.md new file mode 100644 index 00000000000..8fcb76c7525 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/is-custom-tab-intent.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabConfig](index.md) / [isCustomTabIntent](./is-custom-tab-intent.md) + +# isCustomTabIntent + +`fun isCustomTabIntent(intent: `[`SafeIntent`](../../mozilla.components.support.utils/-safe-intent/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L75) + +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/mozilla.components.browser.session.tab/-custom-tab-config/menu-items.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/menu-items.md new file mode 100644 index 00000000000..d0f87489943 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/menu-items.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabConfig](index.md) / [menuItems](./menu-items.md) + +# menuItems + +`val menuItems: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`CustomTabMenuItem`](../-custom-tab-menu-item/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L32) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/options.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/options.md new file mode 100644 index 00000000000..cb1d4553e22 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/options.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabConfig](index.md) / [options](./options.md) + +# 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)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L33) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/show-share-menu-item.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/show-share-menu-item.md new file mode 100644 index 00000000000..e9755c5af5b --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/show-share-menu-item.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabConfig](index.md) / [showShareMenuItem](./show-share-menu-item.md) + +# showShareMenuItem + +`val showShareMenuItem: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L31) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/toolbar-color.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/toolbar-color.md new file mode 100644 index 00000000000..badf09998ec --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-config/toolbar-color.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabConfig](index.md) / [toolbarColor](./toolbar-color.md) + +# toolbarColor + +`val toolbarColor: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L27) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-menu-item/-init-.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-menu-item/-init-.md new file mode 100644 index 00000000000..8eb7efcdac5 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-menu-item/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabMenuItem](index.md) / [<init>](./-init-.md) + +# <init> + +`CustomTabMenuItem(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, pendingIntent: `[`PendingIntent`](https://developer.android.com/reference/android/app/PendingIntent.html)`)` \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-menu-item/index.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-menu-item/index.md new file mode 100644 index 00000000000..7263a950c2a --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-menu-item/index.md @@ -0,0 +1,18 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabMenuItem](./index.md) + +# CustomTabMenuItem + +`data class CustomTabMenuItem` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L197) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `CustomTabMenuItem(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, pendingIntent: `[`PendingIntent`](https://developer.android.com/reference/android/app/PendingIntent.html)`)` | + +### Properties + +| Name | Summary | +|---|---| +| [name](name.md) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [pendingIntent](pending-intent.md) | `val pendingIntent: `[`PendingIntent`](https://developer.android.com/reference/android/app/PendingIntent.html) | diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-menu-item/name.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-menu-item/name.md new file mode 100644 index 00000000000..d012d96586f --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-menu-item/name.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabMenuItem](index.md) / [name](./name.md) + +# name + +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L197) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.tab/-custom-tab-menu-item/pending-intent.md b/docs/api/mozilla.components.browser.session.tab/-custom-tab-menu-item/pending-intent.md new file mode 100644 index 00000000000..2e27fc15f8f --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/-custom-tab-menu-item/pending-intent.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session.tab](../index.md) / [CustomTabMenuItem](index.md) / [pendingIntent](./pending-intent.md) + +# pendingIntent + +`val pendingIntent: `[`PendingIntent`](https://developer.android.com/reference/android/app/PendingIntent.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/tab/CustomTabConfig.kt#L197) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session.tab/index.md b/docs/api/mozilla.components.browser.session.tab/index.md new file mode 100644 index 00000000000..14baf3551d3 --- /dev/null +++ b/docs/api/mozilla.components.browser.session.tab/index.md @@ -0,0 +1,11 @@ +[android-components](../index.md) / [mozilla.components.browser.session.tab](./index.md) + +## Package mozilla.components.browser.session.tab + +### Types + +| Name | Summary | +|---|---| +| [CustomTabActionButtonConfig](-custom-tab-action-button-config/index.md) | `data class CustomTabActionButtonConfig` | +| [CustomTabConfig](-custom-tab-config/index.md) | `class CustomTabConfig`
Holds configuration data for a Custom Tab. Use [createFromIntent](-custom-tab-config/create-from-intent.md) to create instances. | +| [CustomTabMenuItem](-custom-tab-menu-item/index.md) | `data class CustomTabMenuItem` | diff --git a/docs/api/mozilla.components.browser.session/-download/-init-.md b/docs/api/mozilla.components.browser.session/-download/-init-.md new file mode 100644 index 00000000000..ff6b56c70e4 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-download/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Download](index.md) / [<init>](./-init-.md) + +# <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)`, 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/mozilla.components.browser.session/-download/content-length.md b/docs/api/mozilla.components.browser.session/-download/content-length.md new file mode 100644 index 00000000000..4fc7a305126 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-download/content-length.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Download](index.md) / [contentLength](./content-length.md) + +# contentLength + +`val contentLength: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Download.kt#L23) + +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/mozilla.components.browser.session/-download/content-type.md b/docs/api/mozilla.components.browser.session/-download/content-type.md new file mode 100644 index 00000000000..08a4930ee97 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-download/content-type.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Download](index.md) / [contentType](./content-type.md) + +# contentType + +`val contentType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Download.kt#L22) + +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/mozilla.components.browser.session/-download/destination-directory.md b/docs/api/mozilla.components.browser.session/-download/destination-directory.md new file mode 100644 index 00000000000..b86c2164de5 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-download/destination-directory.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Download](index.md) / [destinationDirectory](./destination-directory.md) + +# destinationDirectory + +`val destinationDirectory: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Download.kt#L25) + +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/mozilla.components.browser.session/-download/file-name.md b/docs/api/mozilla.components.browser.session/-download/file-name.md new file mode 100644 index 00000000000..01e43fbb5ad --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-download/file-name.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Download](index.md) / [fileName](./file-name.md) + +# fileName + +`val fileName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Download.kt#L21) + +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/mozilla.components.browser.session/-download/index.md b/docs/api/mozilla.components.browser.session/-download/index.md new file mode 100644 index 00000000000..d5a457576bc --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-download/index.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Download](./index.md) + +# Download + +`data class Download` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Download.kt#L19) + +Value type that represents a Download. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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)`, 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 + +| Name | Summary | +|---|---| +| [contentLength](content-length.md) | `val contentLength: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?`
The file size reported by the server. | +| [contentType](content-type.md) | `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.md) | `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.md) | `val fileName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
A canonical filename for this download. | +| [url](url.md) | `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.md) | `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/mozilla.components.browser.session/-download/url.md b/docs/api/mozilla.components.browser.session/-download/url.md new file mode 100644 index 00000000000..d9f6d7d1910 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-download/url.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Download](index.md) / [url](./url.md) + +# url + +`val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Download.kt#L20) + +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/mozilla.components.browser.session/-download/user-agent.md b/docs/api/mozilla.components.browser.session/-download/user-agent.md new file mode 100644 index 00000000000..938dacc2801 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-download/user-agent.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Download](index.md) / [userAgent](./user-agent.md) + +# userAgent + +`val userAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Download.kt#L24) + +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/mozilla.components.browser.session/-selection-aware-session-observer/-init-.md b/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/-init-.md new file mode 100644 index 00000000000..e49cd39c80d --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/-init-.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SelectionAwareSessionObserver](index.md) / [<init>](./-init-.md) + +# <init> + +`SelectionAwareSessionObserver(sessionManager: `[`SessionManager`](../-session-manager/index.md)`)` + +This class is a combination of [Session.Observer](../-session/-observer/index.md) and +[SessionManager.Observer](../-session-manager/-observer/index.md). It provides functionality to observe changes to a +specified or selected session, and can automatically take care of switching +over the observer in case a different session gets selected (see +[observeFixed](observe-fixed.md) and [observeSelected](observe-selected.md)). + diff --git a/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/active-session.md b/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/active-session.md new file mode 100644 index 00000000000..2035fdc6387 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/active-session.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SelectionAwareSessionObserver](index.md) / [activeSession](./active-session.md) + +# activeSession + +`protected open var activeSession: `[`Session`](../-session/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SelectionAwareSessionObserver.kt#L23) + +the currently observed session + +### Property + +`activeSession` - the currently observed session \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/index.md b/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/index.md new file mode 100644 index 00000000000..2c7df894a71 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/index.md @@ -0,0 +1,71 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SelectionAwareSessionObserver](./index.md) + +# SelectionAwareSessionObserver + +`abstract class SelectionAwareSessionObserver : `[`Observer`](../-session-manager/-observer/index.md)`, `[`Observer`](../-session/-observer/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SelectionAwareSessionObserver.kt#L19) + +This class is a combination of [Session.Observer](../-session/-observer/index.md) and +[SessionManager.Observer](../-session-manager/-observer/index.md). It provides functionality to observe changes to a +specified or selected session, and can automatically take care of switching +over the observer in case a different session gets selected (see +[observeFixed](observe-fixed.md) and [observeSelected](observe-selected.md)). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SelectionAwareSessionObserver(sessionManager: `[`SessionManager`](../-session-manager/index.md)`)`
This class is a combination of [Session.Observer](../-session/-observer/index.md) and [SessionManager.Observer](../-session-manager/-observer/index.md). It provides functionality to observe changes to a specified or selected session, and can automatically take care of switching over the observer in case a different session gets selected (see [observeFixed](observe-fixed.md) and [observeSelected](observe-selected.md)). | + +### Properties + +| Name | Summary | +|---|---| +| [activeSession](active-session.md) | `open var activeSession: `[`Session`](../-session/index.md)`?`
the currently observed session | + +### Functions + +| Name | Summary | +|---|---| +| [observeFixed](observe-fixed.md) | `fun observeFixed(session: `[`Session`](../-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts observing changes to the specified session. | +| [observeSelected](observe-selected.md) | `fun observeSelected(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts observing changes to the selected session (see [SessionManager.selectedSession](../-session-manager/selected-session.md)). If a different session is selected the observer will automatically be switched over and only notified of changes to the newly selected session. | +| [onSessionSelected](on-session-selected.md) | `open fun onSessionSelected(session: `[`Session`](../-session/index.md)`): `[`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. | +| [stop](stop.md) | `open fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stops the observer. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [onAllSessionsRemoved](../-session-manager/-observer/on-all-sessions-removed.md) | `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. | +| [onAppPermissionRequested](../-session/-observer/on-app-permission-requested.md) | `open fun onAppPermissionRequested(session: `[`Session`](../-session/index.md)`, permissionRequest: `[`PermissionRequest`](../../mozilla.components.concept.engine.permission/-permission-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onCloseWindowRequested](../-session/-observer/on-close-window-requested.md) | `open fun onCloseWindowRequested(session: `[`Session`](../-session/index.md)`, windowRequest: `[`WindowRequest`](../../mozilla.components.concept.engine.window/-window-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onContentPermissionRequested](../-session/-observer/on-content-permission-requested.md) | `open fun onContentPermissionRequested(session: `[`Session`](../-session/index.md)`, permissionRequest: `[`PermissionRequest`](../../mozilla.components.concept.engine.permission/-permission-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onCustomTabConfigChanged](../-session/-observer/on-custom-tab-config-changed.md) | `open fun onCustomTabConfigChanged(session: `[`Session`](../-session/index.md)`, customTabConfig: `[`CustomTabConfig`](../../mozilla.components.browser.session.tab/-custom-tab-config/index.md)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onDesktopModeChanged](../-session/-observer/on-desktop-mode-changed.md) | `open fun onDesktopModeChanged(session: `[`Session`](../-session/index.md)`, 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) | +| [onDownload](../-session/-observer/on-download.md) | `open fun onDownload(session: `[`Session`](../-session/index.md)`, download: `[`Download`](../-download/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onFindResult](../-session/-observer/on-find-result.md) | `open fun onFindResult(session: `[`Session`](../-session/index.md)`, result: `[`FindResult`](../-session/-find-result/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onFullScreenChanged](../-session/-observer/on-full-screen-changed.md) | `open fun onFullScreenChanged(session: `[`Session`](../-session/index.md)`, 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) | +| [onLoadingStateChanged](../-session/-observer/on-loading-state-changed.md) | `open fun onLoadingStateChanged(session: `[`Session`](../-session/index.md)`, 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](../-session/-observer/on-long-press.md) | `open fun onLongPress(session: `[`Session`](../-session/index.md)`, hitResult: `[`HitResult`](../../mozilla.components.concept.engine/-hit-result/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onNavigationStateChanged](../-session/-observer/on-navigation-state-changed.md) | `open fun onNavigationStateChanged(session: `[`Session`](../-session/index.md)`, 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) | +| [onOpenWindowRequested](../-session/-observer/on-open-window-requested.md) | `open fun onOpenWindowRequested(session: `[`Session`](../-session/index.md)`, windowRequest: `[`WindowRequest`](../../mozilla.components.concept.engine.window/-window-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onProgress](../-session/-observer/on-progress.md) | `open fun onProgress(session: `[`Session`](../-session/index.md)`, 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) | +| [onPromptRequested](../-session/-observer/on-prompt-requested.md) | `open fun onPromptRequested(session: `[`Session`](../-session/index.md)`, promptRequest: `[`PromptRequest`](../../mozilla.components.concept.engine.prompt/-prompt-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onSearch](../-session/-observer/on-search.md) | `open fun onSearch(session: `[`Session`](../-session/index.md)`, 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](../-session/-observer/on-security-changed.md) | `open fun onSecurityChanged(session: `[`Session`](../-session/index.md)`, securityInfo: `[`SecurityInfo`](../-session/-security-info/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onSessionAdded](../-session-manager/-observer/on-session-added.md) | `open fun onSessionAdded(session: `[`Session`](../-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
The given session has been added. | +| [onSessionRemoved](../-session-manager/-observer/on-session-removed.md) | `open fun onSessionRemoved(session: `[`Session`](../-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
The given session has been removed. | +| [onSessionsRestored](../-session-manager/-observer/on-sessions-restored.md) | `open fun onSessionsRestored(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Sessions have been restored via a snapshot. This callback is invoked at the end of the call to read, after every session in the snapshot was added, and appropriate session was selected. | +| [onThumbnailChanged](../-session/-observer/on-thumbnail-changed.md) | `open fun onThumbnailChanged(session: `[`Session`](../-session/index.md)`, bitmap: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onTitleChanged](../-session/-observer/on-title-changed.md) | `open fun onTitleChanged(session: `[`Session`](../-session/index.md)`, 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](../-session/-observer/on-tracker-blocked.md) | `open fun onTrackerBlocked(session: `[`Session`](../-session/index.md)`, 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](../-session/-observer/on-tracker-blocking-enabled-changed.md) | `open fun onTrackerBlockingEnabledChanged(session: `[`Session`](../-session/index.md)`, 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](../-session/-observer/on-url-changed.md) | `open fun onUrlChanged(session: `[`Session`](../-session/index.md)`, 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) | + +### Inheritors + +| Name | Summary | +|---|---| +| [CoordinateScrollingFeature](../../mozilla.components.feature.session/-coordinate-scrolling-feature/index.md) | `class CoordinateScrollingFeature : `[`SelectionAwareSessionObserver`](./index.md)`, `[`LifecycleAwareFeature`](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)
Feature implementation for connecting an [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) with any View that you want to coordinate scrolling behavior with. | +| [DownloadsFeature](../../mozilla.components.feature.downloads/-downloads-feature/index.md) | `class DownloadsFeature : `[`SelectionAwareSessionObserver`](./index.md)`, `[`LifecycleAwareFeature`](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)
Feature implementation to provide download functionality for the selected session. The feature will subscribe to the selected session and listen for downloads. | +| [FullScreenFeature](../../mozilla.components.feature.session/-full-screen-feature/index.md) | `open class FullScreenFeature : `[`SelectionAwareSessionObserver`](./index.md)`, `[`LifecycleAwareFeature`](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)`, `[`BackHandler`](../../mozilla.components.support.base.feature/-back-handler/index.md)
Feature implementation for handling fullscreen mode (exiting and back button presses). | +| [ToolbarPresenter](../../mozilla.components.feature.toolbar/-toolbar-presenter/index.md) | `class ToolbarPresenter : `[`SelectionAwareSessionObserver`](./index.md)
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/mozilla.components.browser.session/-selection-aware-session-observer/observe-fixed.md b/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/observe-fixed.md new file mode 100644 index 00000000000..7abe4f8f453 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/observe-fixed.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SelectionAwareSessionObserver](index.md) / [observeFixed](./observe-fixed.md) + +# observeFixed + +`fun observeFixed(session: `[`Session`](../-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SelectionAwareSessionObserver.kt#L30) + +Starts observing changes to the specified session. + +### Parameters + +`session` - the session to observe. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/observe-selected.md b/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/observe-selected.md new file mode 100644 index 00000000000..33d90a90fb2 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/observe-selected.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SelectionAwareSessionObserver](index.md) / [observeSelected](./observe-selected.md) + +# observeSelected + +`fun observeSelected(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SelectionAwareSessionObserver.kt#L41) + +Starts observing changes to the selected session (see +[SessionManager.selectedSession](../-session-manager/selected-session.md)). If a different session is selected +the observer will automatically be switched over and only notified of +changes to the newly selected session. + diff --git a/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/on-session-selected.md b/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/on-session-selected.md new file mode 100644 index 00000000000..6efd6fa099b --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/on-session-selected.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SelectionAwareSessionObserver](index.md) / [onSessionSelected](./on-session-selected.md) + +# onSessionSelected + +`@CallSuper open fun onSessionSelected(session: `[`Session`](../-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SelectionAwareSessionObserver.kt#L57) + +Overrides [Observer.onSessionSelected](../-session-manager/-observer/on-session-selected.md) + +The selection has changed and the given session is now the selected session. + diff --git a/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/stop.md b/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/stop.md new file mode 100644 index 00000000000..8c4ccccbb19 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-selection-aware-session-observer/stop.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SelectionAwareSessionObserver](index.md) / [stop](./stop.md) + +# stop + +`@CallSuper open fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SelectionAwareSessionObserver.kt#L51) + +Stops the observer. + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/-init-.md b/docs/api/mozilla.components.browser.session/-session-manager/-init-.md new file mode 100644 index 00000000000..695b390f161 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [<init>](./-init-.md) + +# <init> + +`SessionManager(engine: `[`Engine`](../../mozilla.components.concept.engine/-engine/index.md)`, defaultSession: () -> `[`Session`](../-session/index.md)` = null, delegate: `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](-observer/index.md)`> = ObserverRegistry())` + +This class provides access to a centralized registry of all active sessions. + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/-n-o_-s-e-l-e-c-t-i-o-n.md b/docs/api/mozilla.components.browser.session/-session-manager/-n-o_-s-e-l-e-c-t-i-o-n.md new file mode 100644 index 00000000000..c20ef3777ca --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-n-o_-s-e-l-e-c-t-i-o-n.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [NO_SELECTION](./-n-o_-s-e-l-e-c-t-i-o-n.md) + +# NO_SELECTION + +`const val NO_SELECTION: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L484) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session-manager/-observer/index.md b/docs/api/mozilla.components.browser.session/-session-manager/-observer/index.md new file mode 100644 index 00000000000..70716a4cf49 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-observer/index.md @@ -0,0 +1,25 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [SessionManager](../index.md) / [Observer](./index.md) + +# Observer + +`interface Observer` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L490) + +Interface to be implemented by classes that want to observe the session manager. + +### Functions + +| Name | Summary | +|---|---| +| [onAllSessionsRemoved](on-all-sessions-removed.md) | `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.md) | `open fun onSessionAdded(session: `[`Session`](../../-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
The given session has been added. | +| [onSessionRemoved](on-session-removed.md) | `open fun onSessionRemoved(session: `[`Session`](../../-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
The given session has been removed. | +| [onSessionSelected](on-session-selected.md) | `open fun onSessionSelected(session: `[`Session`](../../-session/index.md)`): `[`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. | +| [onSessionsRestored](on-sessions-restored.md) | `open fun onSessionsRestored(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Sessions have been restored via a snapshot. This callback is invoked at the end of the call to read, after every session in the snapshot was added, and appropriate session was selected. | + +### Inheritors + +| Name | Summary | +|---|---| +| [EngineViewPresenter](../../../mozilla.components.feature.session/-engine-view-presenter/index.md) | `class EngineViewPresenter : `[`Observer`](./index.md)
Presenter implementation for EngineView. | +| [SelectionAwareSessionObserver](../../-selection-aware-session-observer/index.md) | `abstract class SelectionAwareSessionObserver : `[`Observer`](./index.md)`, `[`Observer`](../../-session/-observer/index.md)
This class is a combination of [Session.Observer](../../-session/-observer/index.md) and [SessionManager.Observer](./index.md). It provides functionality to observe changes to a specified or selected session, and can automatically take care of switching over the observer in case a different session gets selected (see [observeFixed](../../-selection-aware-session-observer/observe-fixed.md) and [observeSelected](../../-selection-aware-session-observer/observe-selected.md)). | +| [TabsTrayPresenter](../../../mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/index.md) | `class TabsTrayPresenter : `[`Observer`](./index.md)
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/mozilla.components.browser.session/-session-manager/-observer/on-all-sessions-removed.md b/docs/api/mozilla.components.browser.session/-session-manager/-observer/on-all-sessions-removed.md new file mode 100644 index 00000000000..738d272781d --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-observer/on-all-sessions-removed.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [SessionManager](../index.md) / [Observer](index.md) / [onAllSessionsRemoved](./on-all-sessions-removed.md) + +# onAllSessionsRemoved + +`open fun onAllSessionsRemoved(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L519) + +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/mozilla.components.browser.session/-session-manager/-observer/on-session-added.md b/docs/api/mozilla.components.browser.session/-session-manager/-observer/on-session-added.md new file mode 100644 index 00000000000..42b86cd3012 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-observer/on-session-added.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [SessionManager](../index.md) / [Observer](index.md) / [onSessionAdded](./on-session-added.md) + +# onSessionAdded + +`open fun onSessionAdded(session: `[`Session`](../../-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L499) + +The given session has been added. + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/-observer/on-session-removed.md b/docs/api/mozilla.components.browser.session/-session-manager/-observer/on-session-removed.md new file mode 100644 index 00000000000..f182dc19b9c --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-observer/on-session-removed.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [SessionManager](../index.md) / [Observer](index.md) / [onSessionRemoved](./on-session-removed.md) + +# onSessionRemoved + +`open fun onSessionRemoved(session: `[`Session`](../../-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L511) + +The given session has been removed. + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/-observer/on-session-selected.md b/docs/api/mozilla.components.browser.session/-session-manager/-observer/on-session-selected.md new file mode 100644 index 00000000000..ae15e1d0479 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-observer/on-session-selected.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [SessionManager](../index.md) / [Observer](index.md) / [onSessionSelected](./on-session-selected.md) + +# onSessionSelected + +`open fun onSessionSelected(session: `[`Session`](../../-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L494) + +The selection has changed and the given session is now the selected session. + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/-observer/on-sessions-restored.md b/docs/api/mozilla.components.browser.session/-session-manager/-observer/on-sessions-restored.md new file mode 100644 index 00000000000..b7eab8b9b35 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-observer/on-sessions-restored.md @@ -0,0 +1,10 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [SessionManager](../index.md) / [Observer](index.md) / [onSessionsRestored](./on-sessions-restored.md) + +# onSessionsRestored + +`open fun onSessionsRestored(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L506) + +Sessions have been restored via a snapshot. This callback is invoked at the end of the +call to read, after every session in the snapshot was added, and +appropriate session was selected. + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-init-.md b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-init-.md new file mode 100644 index 00000000000..6ba30119fd9 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [SessionManager](../index.md) / [Snapshot](index.md) / [<init>](./-init-.md) + +# <init> + +`Snapshot(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Item`](-item/index.md)`>, selectedSessionIndex: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/-init-.md b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/-init-.md new file mode 100644 index 00000000000..8a9b3ab770e --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.browser.session](../../../index.md) / [SessionManager](../../index.md) / [Snapshot](../index.md) / [Item](index.md) / [<init>](./-init-.md) + +# <init> + +`Item(session: `[`Session`](../../../-session/index.md)`, engineSession: `[`EngineSession`](../../../../mozilla.components.concept.engine/-engine-session/index.md)`? = null, engineSessionState: `[`EngineSessionState`](../../../../mozilla.components.concept.engine/-engine-session-state/index.md)`? = null)` \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/engine-session-state.md b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/engine-session-state.md new file mode 100644 index 00000000000..ae808abe462 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/engine-session-state.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.browser.session](../../../index.md) / [SessionManager](../../index.md) / [Snapshot](../index.md) / [Item](index.md) / [engineSessionState](./engine-session-state.md) + +# engineSessionState + +`val engineSessionState: `[`EngineSessionState`](../../../../mozilla.components.concept.engine/-engine-session-state/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L531) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/engine-session.md b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/engine-session.md new file mode 100644 index 00000000000..d7d035de126 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/engine-session.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.browser.session](../../../index.md) / [SessionManager](../../index.md) / [Snapshot](../index.md) / [Item](index.md) / [engineSession](./engine-session.md) + +# engineSession + +`val engineSession: `[`EngineSession`](../../../../mozilla.components.concept.engine/-engine-session/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L530) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/index.md b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/index.md new file mode 100644 index 00000000000..a0a4febfcfc --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/index.md @@ -0,0 +1,19 @@ +[android-components](../../../../index.md) / [mozilla.components.browser.session](../../../index.md) / [SessionManager](../../index.md) / [Snapshot](../index.md) / [Item](./index.md) + +# Item + +`data class Item` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L528) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Item(session: `[`Session`](../../../-session/index.md)`, engineSession: `[`EngineSession`](../../../../mozilla.components.concept.engine/-engine-session/index.md)`? = null, engineSessionState: `[`EngineSessionState`](../../../../mozilla.components.concept.engine/-engine-session-state/index.md)`? = null)` | + +### Properties + +| Name | Summary | +|---|---| +| [engineSession](engine-session.md) | `val engineSession: `[`EngineSession`](../../../../mozilla.components.concept.engine/-engine-session/index.md)`?` | +| [engineSessionState](engine-session-state.md) | `val engineSessionState: `[`EngineSessionState`](../../../../mozilla.components.concept.engine/-engine-session-state/index.md)`?` | +| [session](session.md) | `val session: `[`Session`](../../../-session/index.md) | diff --git a/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/session.md b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/session.md new file mode 100644 index 00000000000..ffe068162d5 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/-item/session.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.browser.session](../../../index.md) / [SessionManager](../../index.md) / [Snapshot](../index.md) / [Item](index.md) / [session](./session.md) + +# session + +`val session: `[`Session`](../../../-session/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L529) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/index.md b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/index.md new file mode 100644 index 00000000000..554fd50ef8f --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/index.md @@ -0,0 +1,30 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [SessionManager](../index.md) / [Snapshot](./index.md) + +# Snapshot + +`data class Snapshot` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L522) + +### Types + +| Name | Summary | +|---|---| +| [Item](-item/index.md) | `data class Item` | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Snapshot(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Item`](-item/index.md)`>, selectedSessionIndex: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` | + +### Properties + +| Name | Summary | +|---|---| +| [selectedSessionIndex](selected-session-index.md) | `val selectedSessionIndex: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [sessions](sessions.md) | `val sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Item`](-item/index.md)`>` | + +### Functions + +| Name | Summary | +|---|---| +| [isEmpty](is-empty.md) | `fun isEmpty(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | diff --git a/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/is-empty.md b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/is-empty.md new file mode 100644 index 00000000000..ed42fccd7d8 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/is-empty.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [SessionManager](../index.md) / [Snapshot](index.md) / [isEmpty](./is-empty.md) + +# isEmpty + +`fun isEmpty(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L526) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/selected-session-index.md b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/selected-session-index.md new file mode 100644 index 00000000000..fa3a6db04c4 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/selected-session-index.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [SessionManager](../index.md) / [Snapshot](index.md) / [selectedSessionIndex](./selected-session-index.md) + +# selectedSessionIndex + +`val selectedSessionIndex: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L524) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/sessions.md b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/sessions.md new file mode 100644 index 00000000000..151cd7c0453 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/-snapshot/sessions.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [SessionManager](../index.md) / [Snapshot](index.md) / [sessions](./sessions.md) + +# sessions + +`val sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Item`](-item/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L523) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session-manager/add.md b/docs/api/mozilla.components.browser.session/-session-manager/add.md new file mode 100644 index 00000000000..b923c21a799 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/add.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [add](./add.md) + +# add + +`fun add(session: `[`Session`](../-session/index.md)`, selected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, engineSession: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`? = null, parent: `[`Session`](../-session/index.md)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L132) + +Adds the provided session. + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/all.md b/docs/api/mozilla.components.browser.session/-session-manager/all.md new file mode 100644 index 00000000000..2dc1645fa19 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/all.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [all](./all.md) + +# all + +`val all: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Session`](../-session/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L126) + +Returns a list of all active sessions (including CustomTab sessions). + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/create-snapshot.md b/docs/api/mozilla.components.browser.session/-session-manager/create-snapshot.md new file mode 100644 index 00000000000..a5f4253b292 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/create-snapshot.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [createSnapshot](./create-snapshot.md) + +# createSnapshot + +`fun createSnapshot(): `[`Snapshot`](-snapshot/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L42) + +Produces a snapshot of this manager's state, suitable for restoring via [SessionManager.restore](restore.md). +Only regular sessions are included in the snapshot. Private and Custom Tab sessions are omitted. + +**Return** +[Snapshot](-snapshot/index.md) or null if no sessions are present. + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/default-session.md b/docs/api/mozilla.components.browser.session/-session-manager/default-session.md new file mode 100644 index 00000000000..3ca8a824105 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/default-session.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [defaultSession](./default-session.md) + +# defaultSession + +`val defaultSession: () -> `[`Session`](../-session/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L22) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session-manager/engine.md b/docs/api/mozilla.components.browser.session/-session-manager/engine.md new file mode 100644 index 00000000000..36023c8dd59 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/engine.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [engine](./engine.md) + +# engine + +`val engine: `[`Engine`](../../mozilla.components.concept.engine/-engine/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L21) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session-manager/find-session-by-id.md b/docs/api/mozilla.components.browser.session/-session-manager/find-session-by-id.md new file mode 100644 index 00000000000..29f161890e9 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/find-session-by-id.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [findSessionById](./find-session-by-id.md) + +# findSessionById + +`fun findSessionById(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Session`](../-session/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L467) + +Finds and returns the session with the given id. Returns null if no matching session could be +found. + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/get-engine-session.md b/docs/api/mozilla.components.browser.session/-session-manager/get-engine-session.md new file mode 100644 index 00000000000..4fe0089642c --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/get-engine-session.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [getEngineSession](./get-engine-session.md) + +# getEngineSession + +`fun getEngineSession(session: `[`Session`](../-session/index.md)` = selectedSessionOrThrow): `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L224) + +Gets the linked engine session for the provided session (if it exists). + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/get-or-create-engine-session.md b/docs/api/mozilla.components.browser.session/-session-manager/get-or-create-engine-session.md new file mode 100644 index 00000000000..c619375a6a1 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/get-or-create-engine-session.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [getOrCreateEngineSession](./get-or-create-engine-session.md) + +# getOrCreateEngineSession + +`fun getOrCreateEngineSession(session: `[`Session`](../-session/index.md)` = selectedSessionOrThrow): `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L229) + +Gets the linked engine session for the provided session and creates it if needed. + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/index.md b/docs/api/mozilla.components.browser.session/-session-manager/index.md new file mode 100644 index 00000000000..db5b6b3fa6d --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/index.md @@ -0,0 +1,60 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](./index.md) + +# SessionManager + +`class SessionManager : `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](-observer/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L20) + +This class provides access to a centralized registry of all active sessions. + +### Types + +| Name | Summary | +|---|---| +| [Observer](-observer/index.md) | `interface Observer`
Interface to be implemented by classes that want to observe the session manager. | +| [Snapshot](-snapshot/index.md) | `data class Snapshot` | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SessionManager(engine: `[`Engine`](../../mozilla.components.concept.engine/-engine/index.md)`, defaultSession: () -> `[`Session`](../-session/index.md)` = null, delegate: `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](-observer/index.md)`> = ObserverRegistry())`
This class provides access to a centralized registry of all active sessions. | + +### Properties + +| Name | Summary | +|---|---| +| [all](all.md) | `val all: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Session`](../-session/index.md)`>`
Returns a list of all active sessions (including CustomTab sessions). | +| [defaultSession](default-session.md) | `val defaultSession: () -> `[`Session`](../-session/index.md) | +| [engine](engine.md) | `val engine: `[`Engine`](../../mozilla.components.concept.engine/-engine/index.md) | +| [selectedSession](selected-session.md) | `val selectedSession: `[`Session`](../-session/index.md)`?`
Gets the currently selected session if there is one. | +| [selectedSessionOrThrow](selected-session-or-throw.md) | `val selectedSessionOrThrow: `[`Session`](../-session/index.md)
Gets the currently selected session or throws an IllegalStateException if no session is selected. | +| [sessions](sessions.md) | `val sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Session`](../-session/index.md)`>`
Returns a list of active sessions and filters out sessions used for CustomTabs. | +| [size](size.md) | `val size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns the number of session including CustomTab sessions. | + +### Functions + +| Name | Summary | +|---|---| +| [add](add.md) | `fun add(session: `[`Session`](../-session/index.md)`, selected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, engineSession: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`? = null, parent: `[`Session`](../-session/index.md)`? = null): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Adds the provided session. | +| [createSnapshot](create-snapshot.md) | `fun createSnapshot(): `[`Snapshot`](-snapshot/index.md)`?`
Produces a snapshot of this manager's state, suitable for restoring via [SessionManager.restore](restore.md). Only regular sessions are included in the snapshot. Private and Custom Tab sessions are omitted. | +| [findSessionById](find-session-by-id.md) | `fun findSessionById(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Session`](../-session/index.md)`?`
Finds and returns the session with the given id. Returns null if no matching session could be found. | +| [getEngineSession](get-engine-session.md) | `fun getEngineSession(session: `[`Session`](../-session/index.md)` = selectedSessionOrThrow): `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`?`
Gets the linked engine session for the provided session (if it exists). | +| [getOrCreateEngineSession](get-or-create-engine-session.md) | `fun getOrCreateEngineSession(session: `[`Session`](../-session/index.md)` = selectedSessionOrThrow): `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)
Gets the linked engine session for the provided session and creates it if needed. | +| [onLowMemory](on-low-memory.md) | `fun onLowMemory(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Informs this [SessionManager](./index.md) that the OS is in low memory condition so it can reduce its allocated objects. | +| [remove](remove.md) | `fun remove(session: `[`Session`](../-session/index.md)` = selectedSessionOrThrow, selectParentIfExists: `[`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)
Removes the provided session. If no session is provided then the selected session is removed. | +| [removeAll](remove-all.md) | `fun removeAll(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Removes all sessions including CustomTab sessions. | +| [removeSessions](remove-sessions.md) | `fun removeSessions(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Removes all sessions but CustomTab sessions. | +| [restore](restore.md) | `fun restore(snapshot: `[`Snapshot`](-snapshot/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Restores sessions from the provided [Snapshot](-snapshot/index.md). Notification behaviour is as follows: | +| [select](select.md) | `fun select(session: `[`Session`](../-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Marks the given session as selected. | + +### Companion Object Properties + +| Name | Summary | +|---|---| +| [NO_SELECTION](-n-o_-s-e-l-e-c-t-i-o-n.md) | `const val NO_SELECTION: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +### Extension Functions + +| Name | Summary | +|---|---| +| [runWithSession](../run-with-session.md) | `fun `[`SessionManager`](./index.md)`.runWithSession(sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, block: `[`SessionManager`](./index.md)`.(`[`Session`](../-session/index.md)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Tries to find a session with the provided session ID and runs the block if found. | diff --git a/docs/api/mozilla.components.browser.session/-session-manager/on-low-memory.md b/docs/api/mozilla.components.browser.session/-session-manager/on-low-memory.md new file mode 100644 index 00000000000..5691afd53c5 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/on-low-memory.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [onLowMemory](./on-low-memory.md) + +# onLowMemory + +`fun onLowMemory(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L473) + +Informs this [SessionManager](index.md) that the OS is in low memory condition so it +can reduce its allocated objects. + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/remove-all.md b/docs/api/mozilla.components.browser.session/-session-manager/remove-all.md new file mode 100644 index 00000000000..4d5ba177c42 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/remove-all.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [removeAll](./remove-all.md) + +# removeAll + +`fun removeAll(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L430) + +Removes all sessions including CustomTab sessions. + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/remove-sessions.md b/docs/api/mozilla.components.browser.session/-session-manager/remove-sessions.md new file mode 100644 index 00000000000..90aef2387f3 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/remove-sessions.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [removeSessions](./remove-sessions.md) + +# removeSessions + +`fun removeSessions(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L410) + +Removes all sessions but CustomTab sessions. + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/remove.md b/docs/api/mozilla.components.browser.session/-session-manager/remove.md new file mode 100644 index 00000000000..4cde9fd7ded --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/remove.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [remove](./remove.md) + +# remove + +`fun remove(session: `[`Session`](../-session/index.md)` = selectedSessionOrThrow, selectParentIfExists: `[`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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L269) + +Removes the provided session. If no session is provided then the selected session is removed. + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/restore.md b/docs/api/mozilla.components.browser.session/-session-manager/restore.md new file mode 100644 index 00000000000..4f2981aa0aa --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/restore.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [restore](./restore.md) + +# restore + +`fun restore(snapshot: `[`Snapshot`](-snapshot/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L195) + +Restores sessions from the provided [Snapshot](-snapshot/index.md). +Notification behaviour is as follows: + +* onSessionAdded notifications will not fire, +* onSessionSelected notification will fire exactly once if the snapshot isn't empty, +* once snapshot has been restored, and appropriate session has been selected, onSessionsRestored +notification will fire. + +### Parameters + +`snapshot` - A [Snapshot](-snapshot/index.md) which may be produced by [createSnapshot](create-snapshot.md). + +### Exceptions + +`IllegalArgumentException` - if an empty snapshot is passed in. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session-manager/select.md b/docs/api/mozilla.components.browser.session/-session-manager/select.md new file mode 100644 index 00000000000..3ef704eeeb7 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/select.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [select](./select.md) + +# select + +`fun select(session: `[`Session`](../-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L451) + +Marks the given session as selected. + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/selected-session-or-throw.md b/docs/api/mozilla.components.browser.session/-session-manager/selected-session-or-throw.md new file mode 100644 index 00000000000..bb97b97e9b5 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/selected-session-or-throw.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [selectedSessionOrThrow](./selected-session-or-throw.md) + +# selectedSessionOrThrow + +`val selectedSessionOrThrow: `[`Session`](../-session/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L114) + +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/mozilla.components.browser.session/-session-manager/selected-session.md b/docs/api/mozilla.components.browser.session/-session-manager/selected-session.md new file mode 100644 index 00000000000..051744b47b9 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/selected-session.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [selectedSession](./selected-session.md) + +# selectedSession + +`val selectedSession: `[`Session`](../-session/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L93) + +Gets the currently selected session if there is one. + +Only one session can be selected at a given time. + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/sessions.md b/docs/api/mozilla.components.browser.session/-session-manager/sessions.md new file mode 100644 index 00000000000..5ad37d0c36c --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/sessions.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [sessions](./sessions.md) + +# sessions + +`val sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Session`](../-session/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L120) + +Returns a list of active sessions and filters out sessions used for CustomTabs. + diff --git a/docs/api/mozilla.components.browser.session/-session-manager/size.md b/docs/api/mozilla.components.browser.session/-session-manager/size.md new file mode 100644 index 00000000000..a727dc4c4ef --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session-manager/size.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [SessionManager](index.md) / [size](./size.md) + +# size + +`val size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L33) + +Returns the number of session including CustomTab sessions. + diff --git a/docs/api/mozilla.components.browser.session/-session/-find-result/-init-.md b/docs/api/mozilla.components.browser.session/-session/-find-result/-init-.md new file mode 100644 index 00000000000..1ba31bfb847 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-find-result/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [FindResult](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.browser.session/-session/-find-result/active-match-ordinal.md b/docs/api/mozilla.components.browser.session/-session/-find-result/active-match-ordinal.md new file mode 100644 index 00000000000..ca4f6975d45 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-find-result/active-match-ordinal.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [FindResult](index.md) / [activeMatchOrdinal](./active-match-ordinal.md) + +# activeMatchOrdinal + +`val activeMatchOrdinal: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L137) + +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/mozilla.components.browser.session/-session/-find-result/index.md b/docs/api/mozilla.components.browser.session/-session/-find-result/index.md new file mode 100644 index 00000000000..ef817b6bd5f --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-find-result/index.md @@ -0,0 +1,21 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [FindResult](./index.md) + +# FindResult + +`data class FindResult` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L137) + +A value type representing a result of a "find in page" operation. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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 + +| Name | Summary | +|---|---| +| [activeMatchOrdinal](active-match-ordinal.md) | `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.md) | `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.md) | `val numberOfMatches: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
the match count | diff --git a/docs/api/mozilla.components.browser.session/-session/-find-result/is-done-counting.md b/docs/api/mozilla.components.browser.session/-session/-find-result/is-done-counting.md new file mode 100644 index 00000000000..fe653efada9 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-find-result/is-done-counting.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [FindResult](index.md) / [isDoneCounting](./is-done-counting.md) + +# isDoneCounting + +`val isDoneCounting: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L137) + +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/mozilla.components.browser.session/-session/-find-result/number-of-matches.md b/docs/api/mozilla.components.browser.session/-session/-find-result/number-of-matches.md new file mode 100644 index 00000000000..70789a78d07 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-find-result/number-of-matches.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [FindResult](index.md) / [numberOfMatches](./number-of-matches.md) + +# numberOfMatches + +`val numberOfMatches: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L137) + +the match count + +### Property + +`numberOfMatches` - the match count \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-init-.md b/docs/api/mozilla.components.browser.session/-session/-init-.md new file mode 100644 index 00000000000..891647a6623 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [<init>](./-init-.md) + +# <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.md)` = Source.NONE, id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = UUID.randomUUID().toString(), delegate: `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](-observer/index.md)`> = ObserverRegistry())` + +Value type that represents the state of a browser session. Changes can be observed. + diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/index.md b/docs/api/mozilla.components.browser.session/-session/-observer/index.md new file mode 100644 index 00000000000..b786a341493 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/index.md @@ -0,0 +1,40 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](./index.md) + +# Observer + +`interface Observer` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L46) + +Interface to be implemented by classes that want to observe a session. + +### Functions + +| Name | Summary | +|---|---| +| [onAppPermissionRequested](on-app-permission-requested.md) | `open fun onAppPermissionRequested(session: `[`Session`](../index.md)`, permissionRequest: `[`PermissionRequest`](../../../mozilla.components.concept.engine.permission/-permission-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onCloseWindowRequested](on-close-window-requested.md) | `open fun onCloseWindowRequested(session: `[`Session`](../index.md)`, windowRequest: `[`WindowRequest`](../../../mozilla.components.concept.engine.window/-window-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onContentPermissionRequested](on-content-permission-requested.md) | `open fun onContentPermissionRequested(session: `[`Session`](../index.md)`, permissionRequest: `[`PermissionRequest`](../../../mozilla.components.concept.engine.permission/-permission-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onCustomTabConfigChanged](on-custom-tab-config-changed.md) | `open fun onCustomTabConfigChanged(session: `[`Session`](../index.md)`, customTabConfig: `[`CustomTabConfig`](../../../mozilla.components.browser.session.tab/-custom-tab-config/index.md)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onDesktopModeChanged](on-desktop-mode-changed.md) | `open fun onDesktopModeChanged(session: `[`Session`](../index.md)`, 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) | +| [onDownload](on-download.md) | `open fun onDownload(session: `[`Session`](../index.md)`, download: `[`Download`](../../-download/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onFindResult](on-find-result.md) | `open fun onFindResult(session: `[`Session`](../index.md)`, result: `[`FindResult`](../-find-result/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onFullScreenChanged](on-full-screen-changed.md) | `open fun onFullScreenChanged(session: `[`Session`](../index.md)`, 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) | +| [onLoadingStateChanged](on-loading-state-changed.md) | `open fun onLoadingStateChanged(session: `[`Session`](../index.md)`, 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.md) | `open fun onLongPress(session: `[`Session`](../index.md)`, hitResult: `[`HitResult`](../../../mozilla.components.concept.engine/-hit-result/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onNavigationStateChanged](on-navigation-state-changed.md) | `open fun onNavigationStateChanged(session: `[`Session`](../index.md)`, 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) | +| [onOpenWindowRequested](on-open-window-requested.md) | `open fun onOpenWindowRequested(session: `[`Session`](../index.md)`, windowRequest: `[`WindowRequest`](../../../mozilla.components.concept.engine.window/-window-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onProgress](on-progress.md) | `open fun onProgress(session: `[`Session`](../index.md)`, 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) | +| [onPromptRequested](on-prompt-requested.md) | `open fun onPromptRequested(session: `[`Session`](../index.md)`, promptRequest: `[`PromptRequest`](../../../mozilla.components.concept.engine.prompt/-prompt-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onSearch](on-search.md) | `open fun onSearch(session: `[`Session`](../index.md)`, 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.md) | `open fun onSecurityChanged(session: `[`Session`](../index.md)`, securityInfo: `[`SecurityInfo`](../-security-info/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onThumbnailChanged](on-thumbnail-changed.md) | `open fun onThumbnailChanged(session: `[`Session`](../index.md)`, bitmap: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onTitleChanged](on-title-changed.md) | `open fun onTitleChanged(session: `[`Session`](../index.md)`, 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.md) | `open fun onTrackerBlocked(session: `[`Session`](../index.md)`, 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.md) | `open fun onTrackerBlockingEnabledChanged(session: `[`Session`](../index.md)`, 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.md) | `open fun onUrlChanged(session: `[`Session`](../index.md)`, 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) | + +### Inheritors + +| Name | Summary | +|---|---| +| [SelectionAwareSessionObserver](../../-selection-aware-session-observer/index.md) | `abstract class SelectionAwareSessionObserver : `[`Observer`](../../-session-manager/-observer/index.md)`, `[`Observer`](./index.md)
This class is a combination of [Session.Observer](./index.md) and [SessionManager.Observer](../../-session-manager/-observer/index.md). It provides functionality to observe changes to a specified or selected session, and can automatically take care of switching over the observer in case a different session gets selected (see [observeFixed](../../-selection-aware-session-observer/observe-fixed.md) and [observeSelected](../../-selection-aware-session-observer/observe-selected.md)). | +| [TabViewHolder](../../../mozilla.components.browser.tabstray/-tab-view-holder/index.md) | `class TabViewHolder : ViewHolder, `[`Observer`](./index.md)
A RecyclerView ViewHolder implementation for "tab" items. | diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-app-permission-requested.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-app-permission-requested.md new file mode 100644 index 00000000000..717a26ccc9f --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-app-permission-requested.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onAppPermissionRequested](./on-app-permission-requested.md) + +# onAppPermissionRequested + +`open fun onAppPermissionRequested(session: `[`Session`](../index.md)`, permissionRequest: `[`PermissionRequest`](../../../mozilla.components.concept.engine.permission/-permission-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L64) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-close-window-requested.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-close-window-requested.md new file mode 100644 index 00000000000..baf56730ecb --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-close-window-requested.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onCloseWindowRequested](./on-close-window-requested.md) + +# onCloseWindowRequested + +`open fun onCloseWindowRequested(session: `[`Session`](../index.md)`, windowRequest: `[`WindowRequest`](../../../mozilla.components.concept.engine.window/-window-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L67) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-content-permission-requested.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-content-permission-requested.md new file mode 100644 index 00000000000..ad0e127eab4 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-content-permission-requested.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onContentPermissionRequested](./on-content-permission-requested.md) + +# onContentPermissionRequested + +`open fun onContentPermissionRequested(session: `[`Session`](../index.md)`, permissionRequest: `[`PermissionRequest`](../../../mozilla.components.concept.engine.permission/-permission-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L63) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-custom-tab-config-changed.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-custom-tab-config-changed.md new file mode 100644 index 00000000000..f9c07b0b231 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-custom-tab-config-changed.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onCustomTabConfigChanged](./on-custom-tab-config-changed.md) + +# onCustomTabConfigChanged + +`open fun onCustomTabConfigChanged(session: `[`Session`](../index.md)`, customTabConfig: `[`CustomTabConfig`](../../../mozilla.components.browser.session.tab/-custom-tab-config/index.md)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L54) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-desktop-mode-changed.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-desktop-mode-changed.md new file mode 100644 index 00000000000..d5b91612312 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-desktop-mode-changed.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onDesktopModeChanged](./on-desktop-mode-changed.md) + +# onDesktopModeChanged + +`open fun onDesktopModeChanged(session: `[`Session`](../index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L60) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-download.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-download.md new file mode 100644 index 00000000000..fcf9b8ff9a3 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-download.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onDownload](./on-download.md) + +# onDownload + +`open fun onDownload(session: `[`Session`](../index.md)`, download: `[`Download`](../../-download/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L55) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-find-result.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-find-result.md new file mode 100644 index 00000000000..3f30945f3f6 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-find-result.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onFindResult](./on-find-result.md) + +# onFindResult + +`open fun onFindResult(session: `[`Session`](../index.md)`, result: `[`FindResult`](../-find-result/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L59) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-full-screen-changed.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-full-screen-changed.md new file mode 100644 index 00000000000..c75bb1e83fc --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-full-screen-changed.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onFullScreenChanged](./on-full-screen-changed.md) + +# onFullScreenChanged + +`open fun onFullScreenChanged(session: `[`Session`](../index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L61) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-loading-state-changed.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-loading-state-changed.md new file mode 100644 index 00000000000..11e4a5954c6 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-loading-state-changed.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onLoadingStateChanged](./on-loading-state-changed.md) + +# onLoadingStateChanged + +`open fun onLoadingStateChanged(session: `[`Session`](../index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L50) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-long-press.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-long-press.md new file mode 100644 index 00000000000..d4dd3731393 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-long-press.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onLongPress](./on-long-press.md) + +# onLongPress + +`open fun onLongPress(session: `[`Session`](../index.md)`, hitResult: `[`HitResult`](../../../mozilla.components.concept.engine/-hit-result/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L58) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-navigation-state-changed.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-navigation-state-changed.md new file mode 100644 index 00000000000..f402ffc7822 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-navigation-state-changed.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onNavigationStateChanged](./on-navigation-state-changed.md) + +# onNavigationStateChanged + +`open fun onNavigationStateChanged(session: `[`Session`](../index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L51) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-open-window-requested.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-open-window-requested.md new file mode 100644 index 00000000000..8760e58860b --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-open-window-requested.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onOpenWindowRequested](./on-open-window-requested.md) + +# onOpenWindowRequested + +`open fun onOpenWindowRequested(session: `[`Session`](../index.md)`, windowRequest: `[`WindowRequest`](../../../mozilla.components.concept.engine.window/-window-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L66) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-progress.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-progress.md new file mode 100644 index 00000000000..ce17284a3ff --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-progress.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onProgress](./on-progress.md) + +# onProgress + +`open fun onProgress(session: `[`Session`](../index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L49) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-prompt-requested.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-prompt-requested.md new file mode 100644 index 00000000000..d992af95833 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-prompt-requested.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onPromptRequested](./on-prompt-requested.md) + +# onPromptRequested + +`open fun onPromptRequested(session: `[`Session`](../index.md)`, promptRequest: `[`PromptRequest`](../../../mozilla.components.concept.engine.prompt/-prompt-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L65) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-search.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-search.md new file mode 100644 index 00000000000..931671dd0ca --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-search.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onSearch](./on-search.md) + +# onSearch + +`open fun onSearch(session: `[`Session`](../index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L52) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-security-changed.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-security-changed.md new file mode 100644 index 00000000000..47b56083185 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-security-changed.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onSecurityChanged](./on-security-changed.md) + +# onSecurityChanged + +`open fun onSecurityChanged(session: `[`Session`](../index.md)`, securityInfo: `[`SecurityInfo`](../-security-info/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L53) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-thumbnail-changed.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-thumbnail-changed.md new file mode 100644 index 00000000000..aa5078595a3 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-thumbnail-changed.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onThumbnailChanged](./on-thumbnail-changed.md) + +# onThumbnailChanged + +`open fun onThumbnailChanged(session: `[`Session`](../index.md)`, bitmap: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L62) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-title-changed.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-title-changed.md new file mode 100644 index 00000000000..0948f685271 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-title-changed.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onTitleChanged](./on-title-changed.md) + +# onTitleChanged + +`open fun onTitleChanged(session: `[`Session`](../index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L48) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-tracker-blocked.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-tracker-blocked.md new file mode 100644 index 00000000000..e982ff8fc13 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-tracker-blocked.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onTrackerBlocked](./on-tracker-blocked.md) + +# onTrackerBlocked + +`open fun onTrackerBlocked(session: `[`Session`](../index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L57) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-tracker-blocking-enabled-changed.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-tracker-blocking-enabled-changed.md new file mode 100644 index 00000000000..21cbc33d087 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-tracker-blocking-enabled-changed.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onTrackerBlockingEnabledChanged](./on-tracker-blocking-enabled-changed.md) + +# onTrackerBlockingEnabledChanged + +`open fun onTrackerBlockingEnabledChanged(session: `[`Session`](../index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L56) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-observer/on-url-changed.md b/docs/api/mozilla.components.browser.session/-session/-observer/on-url-changed.md new file mode 100644 index 00000000000..c6dbacf3d0e --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-observer/on-url-changed.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Observer](index.md) / [onUrlChanged](./on-url-changed.md) + +# onUrlChanged + +`open fun onUrlChanged(session: `[`Session`](../index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L47) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/-security-info/-init-.md b/docs/api/mozilla.components.browser.session/-session/-security-info/-init-.md new file mode 100644 index 00000000000..70a09d837b0 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-security-info/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [SecurityInfo](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.browser.session/-session/-security-info/host.md b/docs/api/mozilla.components.browser.session/-session/-security-info/host.md new file mode 100644 index 00000000000..d9649e9e172 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-security-info/host.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [SecurityInfo](index.md) / [host](./host.md) + +# host + +`val host: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L78) + +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/mozilla.components.browser.session/-session/-security-info/index.md b/docs/api/mozilla.components.browser.session/-session/-security-info/index.md new file mode 100644 index 00000000000..7543ec37df8 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-security-info/index.md @@ -0,0 +1,21 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [SecurityInfo](./index.md) + +# SecurityInfo + +`data class SecurityInfo` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L78) + +A value type holding security information for a Session. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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 + +| Name | Summary | +|---|---| +| [host](host.md) | `val host: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
domain for which the SSL certificate was issued. | +| [issuer](issuer.md) | `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.md) | `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/mozilla.components.browser.session/-session/-security-info/issuer.md b/docs/api/mozilla.components.browser.session/-session/-security-info/issuer.md new file mode 100644 index 00000000000..04578950b14 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-security-info/issuer.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [SecurityInfo](index.md) / [issuer](./issuer.md) + +# issuer + +`val issuer: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L78) + +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/mozilla.components.browser.session/-session/-security-info/secure.md b/docs/api/mozilla.components.browser.session/-session/-security-info/secure.md new file mode 100644 index 00000000000..6543377ce6e --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-security-info/secure.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [SecurityInfo](index.md) / [secure](./secure.md) + +# secure + +`val secure: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L78) + +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/mozilla.components.browser.session/-session/-source/-a-c-t-i-o-n_-s-e-n-d.md b/docs/api/mozilla.components.browser.session/-session/-source/-a-c-t-i-o-n_-s-e-n-d.md new file mode 100644 index 00000000000..31ac275dbc9 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-source/-a-c-t-i-o-n_-s-e-n-d.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Source](index.md) / [ACTION_SEND](./-a-c-t-i-o-n_-s-e-n-d.md) + +# ACTION_SEND + +`ACTION_SEND` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L87) + +Created to handle an ACTION_SEND (share) intent + diff --git a/docs/api/mozilla.components.browser.session/-session/-source/-a-c-t-i-o-n_-v-i-e-w.md b/docs/api/mozilla.components.browser.session/-session/-source/-a-c-t-i-o-n_-v-i-e-w.md new file mode 100644 index 00000000000..858cbac8ea0 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-source/-a-c-t-i-o-n_-v-i-e-w.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Source](index.md) / [ACTION_VIEW](./-a-c-t-i-o-n_-v-i-e-w.md) + +# ACTION_VIEW + +`ACTION_VIEW` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L92) + +Created to handle an ACTION_VIEW intent + diff --git a/docs/api/mozilla.components.browser.session/-session/-source/-c-u-s-t-o-m_-t-a-b.md b/docs/api/mozilla.components.browser.session/-session/-source/-c-u-s-t-o-m_-t-a-b.md new file mode 100644 index 00000000000..46e4a8734eb --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-source/-c-u-s-t-o-m_-t-a-b.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Source](index.md) / [CUSTOM_TAB](./-c-u-s-t-o-m_-t-a-b.md) + +# CUSTOM_TAB + +`CUSTOM_TAB` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L97) + +Created to handle a CustomTabs intent + diff --git a/docs/api/mozilla.components.browser.session/-session/-source/-h-o-m-e_-s-c-r-e-e-n.md b/docs/api/mozilla.components.browser.session/-session/-source/-h-o-m-e_-s-c-r-e-e-n.md new file mode 100644 index 00000000000..d2c499bc994 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-source/-h-o-m-e_-s-c-r-e-e-n.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Source](index.md) / [HOME_SCREEN](./-h-o-m-e_-s-c-r-e-e-n.md) + +# HOME_SCREEN + +`HOME_SCREEN` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L102) + +User interacted with the home screen + diff --git a/docs/api/mozilla.components.browser.session/-session/-source/-m-e-n-u.md b/docs/api/mozilla.components.browser.session/-session/-source/-m-e-n-u.md new file mode 100644 index 00000000000..1312faa7cb8 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-source/-m-e-n-u.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Source](index.md) / [MENU](./-m-e-n-u.md) + +# MENU + +`MENU` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L107) + +User interacted with a menu + diff --git a/docs/api/mozilla.components.browser.session/-session/-source/-n-e-w_-t-a-b.md b/docs/api/mozilla.components.browser.session/-session/-source/-n-e-w_-t-a-b.md new file mode 100644 index 00000000000..fb8c632db19 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-source/-n-e-w_-t-a-b.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Source](index.md) / [NEW_TAB](./-n-e-w_-t-a-b.md) + +# NEW_TAB + +`NEW_TAB` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L112) + +User opened a new tab + diff --git a/docs/api/mozilla.components.browser.session/-session/-source/-n-o-n-e.md b/docs/api/mozilla.components.browser.session/-session/-source/-n-o-n-e.md new file mode 100644 index 00000000000..f1d3d4b9cbc --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-source/-n-o-n-e.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Source](index.md) / [NONE](./-n-o-n-e.md) + +# NONE + +`NONE` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L117) + +Default value and for testing purposes + diff --git a/docs/api/mozilla.components.browser.session/-session/-source/-t-e-x-t_-s-e-l-e-c-t-i-o-n.md b/docs/api/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..9c56a13aa16 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-source/-t-e-x-t_-s-e-l-e-c-t-i-o-n.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Source](index.md) / [TEXT_SELECTION](./-t-e-x-t_-s-e-l-e-c-t-i-o-n.md) + +# TEXT_SELECTION + +`TEXT_SELECTION` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L122) + +Default value and for testing purposes + diff --git a/docs/api/mozilla.components.browser.session/-session/-source/-u-s-e-r_-e-n-t-e-r-e-d.md b/docs/api/mozilla.components.browser.session/-session/-source/-u-s-e-r_-e-n-t-e-r-e-d.md new file mode 100644 index 00000000000..a3b4d8ecdc5 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-source/-u-s-e-r_-e-n-t-e-r-e-d.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Source](index.md) / [USER_ENTERED](./-u-s-e-r_-e-n-t-e-r-e-d.md) + +# USER_ENTERED + +`USER_ENTERED` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L127) + +User entered a URL or search term + diff --git a/docs/api/mozilla.components.browser.session/-session/-source/index.md b/docs/api/mozilla.components.browser.session/-session/-source/index.md new file mode 100644 index 00000000000..a32689b8c59 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/-source/index.md @@ -0,0 +1,21 @@ +[android-components](../../../index.md) / [mozilla.components.browser.session](../../index.md) / [Session](../index.md) / [Source](./index.md) + +# Source + +`enum class Source` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L83) + +Represents the origin of a session to describe how and why it was created. + +### Enum Values + +| Name | Summary | +|---|---| +| [ACTION_SEND](-a-c-t-i-o-n_-s-e-n-d.md) | Created to handle an ACTION_SEND (share) intent | +| [ACTION_VIEW](-a-c-t-i-o-n_-v-i-e-w.md) | Created to handle an ACTION_VIEW intent | +| [CUSTOM_TAB](-c-u-s-t-o-m_-t-a-b.md) | Created to handle a CustomTabs intent | +| [HOME_SCREEN](-h-o-m-e_-s-c-r-e-e-n.md) | User interacted with the home screen | +| [MENU](-m-e-n-u.md) | User interacted with a menu | +| [NEW_TAB](-n-e-w_-t-a-b.md) | User opened a new tab | +| [NONE](-n-o-n-e.md) | Default value and for testing purposes | +| [TEXT_SELECTION](-t-e-x-t_-s-e-l-e-c-t-i-o-n.md) | Default value and for testing purposes | +| [USER_ENTERED](-u-s-e-r_-e-n-t-e-r-e-d.md) | User entered a URL or search term | diff --git a/docs/api/mozilla.components.browser.session/-session/app-permission-request.md b/docs/api/mozilla.components.browser.session/-session/app-permission-request.md new file mode 100644 index 00000000000..6f0066bf8dd --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/app-permission-request.md @@ -0,0 +1,22 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [appPermissionRequest](./app-permission-request.md) + +# appPermissionRequest + +`var appPermissionRequest: `[`Consumable`](../../mozilla.components.support.base.observer/-consumable/index.md)`<`[`PermissionRequest`](../../mozilla.components.concept.engine.permission/-permission-request/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L286) + +[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) permission request for the app. A [PermissionRequest](../../mozilla.components.concept.engine.permission/-permission-request/index.md) +must be consumed i.e. either [PermissionRequest.grant](../../mozilla.components.concept.engine.permission/-permission-request/grant.md) or +[PermissionRequest.reject](../../mozilla.components.concept.engine.permission/-permission-request/reject.md) must be called. + +**Getter** + +[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) permission request for the app. A [PermissionRequest](../../mozilla.components.concept.engine.permission/-permission-request/index.md) +must be consumed i.e. either [PermissionRequest.grant](../../mozilla.components.concept.engine.permission/-permission-request/grant.md) or +[PermissionRequest.reject](../../mozilla.components.concept.engine.permission/-permission-request/reject.md) must be called. + +**Setter** + +[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) permission request for the app. A [PermissionRequest](../../mozilla.components.concept.engine.permission/-permission-request/index.md) +must be consumed i.e. either [PermissionRequest.grant](../../mozilla.components.concept.engine.permission/-permission-request/grant.md) or +[PermissionRequest.reject](../../mozilla.components.concept.engine.permission/-permission-request/reject.md) must be called. + diff --git a/docs/api/mozilla.components.browser.session/-session/can-go-back.md b/docs/api/mozilla.components.browser.session/-session/can-go-back.md new file mode 100644 index 00000000000..8fbd313abca --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/can-go-back.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [canGoBack](./can-go-back.md) + +# canGoBack + +`var canGoBack: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L170) + +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/mozilla.components.browser.session/-session/can-go-forward.md b/docs/api/mozilla.components.browser.session/-session/can-go-forward.md new file mode 100644 index 00000000000..f79443accf2 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/can-go-forward.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [canGoForward](./can-go-forward.md) + +# canGoForward + +`var canGoForward: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L177) + +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/mozilla.components.browser.session/-session/close-window-request.md b/docs/api/mozilla.components.browser.session/-session/close-window-request.md new file mode 100644 index 00000000000..790693fea17 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/close-window-request.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [closeWindowRequest](./close-window-request.md) + +# closeWindowRequest + +`var closeWindowRequest: `[`Consumable`](../../mozilla.components.support.base.observer/-consumable/index.md)`<`[`WindowRequest`](../../mozilla.components.concept.engine.window/-window-request/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L313) + +[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) request to close a window. + +**Getter** + +[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) request to close a window. + +**Setter** + +[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) request to close a window. + diff --git a/docs/api/mozilla.components.browser.session/-session/content-permission-request.md b/docs/api/mozilla.components.browser.session/-session/content-permission-request.md new file mode 100644 index 00000000000..931095e9267 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/content-permission-request.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [contentPermissionRequest](./content-permission-request.md) + +# contentPermissionRequest + +`var contentPermissionRequest: `[`Consumable`](../../mozilla.components.support.base.observer/-consumable/index.md)`<`[`PermissionRequest`](../../mozilla.components.concept.engine.permission/-permission-request/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L275) + +[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) permission request from web content. A [PermissionRequest](../../mozilla.components.concept.engine.permission/-permission-request/index.md) +must be consumed i.e. either [PermissionRequest.grant](../../mozilla.components.concept.engine.permission/-permission-request/grant.md) or +[PermissionRequest.reject](../../mozilla.components.concept.engine.permission/-permission-request/reject.md) must be called. A content permission request +can also be cancelled, which will result in a new empty [Consumable](../../mozilla.components.support.base.observer/-consumable/index.md). + +**Getter** + +[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) permission request from web content. A [PermissionRequest](../../mozilla.components.concept.engine.permission/-permission-request/index.md) +must be consumed i.e. either [PermissionRequest.grant](../../mozilla.components.concept.engine.permission/-permission-request/grant.md) or +[PermissionRequest.reject](../../mozilla.components.concept.engine.permission/-permission-request/reject.md) must be called. A content permission request +can also be cancelled, which will result in a new empty [Consumable](../../mozilla.components.support.base.observer/-consumable/index.md). + +**Setter** + +[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) permission request from web content. A [PermissionRequest](../../mozilla.components.concept.engine.permission/-permission-request/index.md) +must be consumed i.e. either [PermissionRequest.grant](../../mozilla.components.concept.engine.permission/-permission-request/grant.md) or +[PermissionRequest.reject](../../mozilla.components.concept.engine.permission/-permission-request/reject.md) must be called. A content permission request +can also be cancelled, which will result in a new empty [Consumable](../../mozilla.components.support.base.observer/-consumable/index.md). + diff --git a/docs/api/mozilla.components.browser.session/-session/custom-tab-config.md b/docs/api/mozilla.components.browser.session/-session/custom-tab-config.md new file mode 100644 index 00000000000..7cad2984de6 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/custom-tab-config.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [customTabConfig](./custom-tab-config.md) + +# customTabConfig + +`var customTabConfig: `[`CustomTabConfig`](../../mozilla.components.browser.session.tab/-custom-tab-config/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L199) + +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/mozilla.components.browser.session/-session/desktop-mode.md b/docs/api/mozilla.components.browser.session/-session/desktop-mode.md new file mode 100644 index 00000000000..39bb1fbd29a --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/desktop-mode.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [desktopMode](./desktop-mode.md) + +# desktopMode + +`var desktopMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L258) + +Desktop Mode state, true if the desktop mode is requested, otherwise false. + +**Getter** + +Desktop Mode state, true if the desktop mode is requested, otherwise false. + +**Setter** + +Desktop Mode state, true if the desktop mode is requested, otherwise false. + diff --git a/docs/api/mozilla.components.browser.session/-session/download.md b/docs/api/mozilla.components.browser.session/-session/download.md new file mode 100644 index 00000000000..33b71b801ce --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/download.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [download](./download.md) + +# download + +`var download: `[`Consumable`](../../mozilla.components.support.base.observer/-consumable/index.md)`<`[`Download`](../-download/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L206) + +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/mozilla.components.browser.session/-session/equals.md b/docs/api/mozilla.components.browser.session/-session/equals.md new file mode 100644 index 00000000000..403e7ab737f --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/equals.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [equals](./equals.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L333) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/find-results.md b/docs/api/mozilla.components.browser.session/-session/find-results.md new file mode 100644 index 00000000000..a7a478ea454 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/find-results.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [findResults](./find-results.md) + +# findResults + +`var findResults: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`FindResult`](-find-result/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L232) + +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/mozilla.components.browser.session/-session/full-screen-mode.md b/docs/api/mozilla.components.browser.session/-session/full-screen-mode.md new file mode 100644 index 00000000000..babcb4e7792 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/full-screen-mode.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [fullScreenMode](./full-screen-mode.md) + +# fullScreenMode + +`var fullScreenMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L265) + +Exits fullscreen mode if it's in that state. + +**Getter** + +Exits fullscreen mode if it's in that state. + +**Setter** + +Exits fullscreen mode if it's in that state. + diff --git a/docs/api/mozilla.components.browser.session/-session/hash-code.md b/docs/api/mozilla.components.browser.session/-session/hash-code.md new file mode 100644 index 00000000000..08ed6331eb6 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/hash-code.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [hashCode](./hash-code.md) + +# hashCode + +`fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L342) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/hit-result.md b/docs/api/mozilla.components.browser.session/-session/hit-result.md new file mode 100644 index 00000000000..af702cc401a --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/hit-result.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [hitResult](./hit-result.md) + +# hitResult + +`var hitResult: `[`Consumable`](../../mozilla.components.support.base.observer/-consumable/index.md)`<`[`HitResult`](../../mozilla.components.concept.engine/-hit-result/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L243) + +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/mozilla.components.browser.session/-session/id.md b/docs/api/mozilla.components.browser.session/-session/id.md new file mode 100644 index 00000000000..1d4d40852ed --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/id.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L28) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/index.md b/docs/api/mozilla.components.browser.session/-session/index.md new file mode 100644 index 00000000000..bd8acbd69db --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/index.md @@ -0,0 +1,61 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](./index.md) + +# Session + +`class Session : `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](-observer/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L24) + +Value type that represents the state of a browser session. Changes can be observed. + +### Types + +| Name | Summary | +|---|---| +| [FindResult](-find-result/index.md) | `data class FindResult`
A value type representing a result of a "find in page" operation. | +| [Observer](-observer/index.md) | `interface Observer`
Interface to be implemented by classes that want to observe a session. | +| [SecurityInfo](-security-info/index.md) | `data class SecurityInfo`
A value type holding security information for a Session. | +| [Source](-source/index.md) | `enum class Source`
Represents the origin of a session to describe how and why it was created. | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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.md)` = Source.NONE, id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = UUID.randomUUID().toString(), delegate: `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](-observer/index.md)`> = ObserverRegistry())`
Value type that represents the state of a browser session. Changes can be observed. | + +### Properties + +| Name | Summary | +|---|---| +| [appPermissionRequest](app-permission-request.md) | `var appPermissionRequest: `[`Consumable`](../../mozilla.components.support.base.observer/-consumable/index.md)`<`[`PermissionRequest`](../../mozilla.components.concept.engine.permission/-permission-request/index.md)`>`
[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) permission request for the app. A [PermissionRequest](../../mozilla.components.concept.engine.permission/-permission-request/index.md) must be consumed i.e. either [PermissionRequest.grant](../../mozilla.components.concept.engine.permission/-permission-request/grant.md) or [PermissionRequest.reject](../../mozilla.components.concept.engine.permission/-permission-request/reject.md) must be called. | +| [canGoBack](can-go-back.md) | `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.md) | `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. | +| [closeWindowRequest](close-window-request.md) | `var closeWindowRequest: `[`Consumable`](../../mozilla.components.support.base.observer/-consumable/index.md)`<`[`WindowRequest`](../../mozilla.components.concept.engine.window/-window-request/index.md)`>`
[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) request to close a window. | +| [contentPermissionRequest](content-permission-request.md) | `var contentPermissionRequest: `[`Consumable`](../../mozilla.components.support.base.observer/-consumable/index.md)`<`[`PermissionRequest`](../../mozilla.components.concept.engine.permission/-permission-request/index.md)`>`
[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) permission request from web content. A [PermissionRequest](../../mozilla.components.concept.engine.permission/-permission-request/index.md) must be consumed i.e. either [PermissionRequest.grant](../../mozilla.components.concept.engine.permission/-permission-request/grant.md) or [PermissionRequest.reject](../../mozilla.components.concept.engine.permission/-permission-request/reject.md) must be called. A content permission request can also be cancelled, which will result in a new empty [Consumable](../../mozilla.components.support.base.observer/-consumable/index.md). | +| [customTabConfig](custom-tab-config.md) | `var customTabConfig: `[`CustomTabConfig`](../../mozilla.components.browser.session.tab/-custom-tab-config/index.md)`?`
Configuration data in case this session is used for a Custom Tab. | +| [desktopMode](desktop-mode.md) | `var desktopMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Desktop Mode state, true if the desktop mode is requested, otherwise false. | +| [download](download.md) | `var download: `[`Consumable`](../../mozilla.components.support.base.observer/-consumable/index.md)`<`[`Download`](../-download/index.md)`>`
Last download request if it wasn't consumed by at least one observer. | +| [findResults](find-results.md) | `var findResults: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`FindResult`](-find-result/index.md)`>`
List of results of that latest "find in page" operation. | +| [fullScreenMode](full-screen-mode.md) | `var fullScreenMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Exits fullscreen mode if it's in that state. | +| [hitResult](hit-result.md) | `var hitResult: `[`Consumable`](../../mozilla.components.support.base.observer/-consumable/index.md)`<`[`HitResult`](../../mozilla.components.concept.engine/-hit-result/index.md)`>`
The target of the latest long click operation. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [loading](loading.md) | `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. | +| [openWindowRequest](open-window-request.md) | `var openWindowRequest: `[`Consumable`](../../mozilla.components.support.base.observer/-consumable/index.md)`<`[`WindowRequest`](../../mozilla.components.concept.engine.window/-window-request/index.md)`>`
[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) request to open/create a window. | +| [private](private.md) | `val private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [progress](progress.md) | `var progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
The progress loading the current URL. | +| [promptRequest](prompt-request.md) | `var promptRequest: `[`Consumable`](../../mozilla.components.support.base.observer/-consumable/index.md)`<`[`PromptRequest`](../../mozilla.components.concept.engine.prompt/-prompt-request/index.md)`>`
[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) State for a prompt request from web content. | +| [searchTerms](search-terms.md) | `var searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The currently / last used search terms. | +| [securityInfo](security-info.md) | `var securityInfo: `[`SecurityInfo`](-security-info/index.md)
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.md) | `val source: `[`Source`](-source/index.md) | +| [thumbnail](thumbnail.md) | `var thumbnail: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?`
The target of the latest thumbnail. | +| [title](title.md) | `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.md) | `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.md) | `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.md) | `var url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The currently loading or loaded URL. | + +### Functions + +| Name | Summary | +|---|---| +| [equals](equals.md) | `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.md) | `fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [isCustomTabSession](is-custom-tab-session.md) | `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. | +| [toString](to-string.md) | `fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.browser.session/-session/is-custom-tab-session.md b/docs/api/mozilla.components.browser.session/-session/is-custom-tab-session.md new file mode 100644 index 00000000000..d8176a85f33 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/is-custom-tab-session.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [isCustomTabSession](./is-custom-tab-session.md) + +# isCustomTabSession + +`fun isCustomTabSession(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L322) + +Returns whether or not this session is used for a Custom Tab. + diff --git a/docs/api/mozilla.components.browser.session/-session/loading.md b/docs/api/mozilla.components.browser.session/-session/loading.md new file mode 100644 index 00000000000..18a07b6549a --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/loading.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [loading](./loading.md) + +# loading + +`var loading: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L163) + +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/mozilla.components.browser.session/-session/open-window-request.md b/docs/api/mozilla.components.browser.session/-session/open-window-request.md new file mode 100644 index 00000000000..f9d2d831772 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/open-window-request.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [openWindowRequest](./open-window-request.md) + +# openWindowRequest + +`var openWindowRequest: `[`Consumable`](../../mozilla.components.support.base.observer/-consumable/index.md)`<`[`WindowRequest`](../../mozilla.components.concept.engine.window/-window-request/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L304) + +[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) request to open/create a window. + +**Getter** + +[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) request to open/create a window. + +**Setter** + +[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) request to open/create a window. + diff --git a/docs/api/mozilla.components.browser.session/-session/private.md b/docs/api/mozilla.components.browser.session/-session/private.md new file mode 100644 index 00000000000..00da156d5aa --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/private.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [private](./private.md) + +# private + +`val private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L26) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/progress.md b/docs/api/mozilla.components.browser.session/-session/progress.md new file mode 100644 index 00000000000..d8d9767715d --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/progress.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [progress](./progress.md) + +# progress + +`var progress: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L156) + +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/mozilla.components.browser.session/-session/prompt-request.md b/docs/api/mozilla.components.browser.session/-session/prompt-request.md new file mode 100644 index 00000000000..86434923d1f --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/prompt-request.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [promptRequest](./prompt-request.md) + +# promptRequest + +`var promptRequest: `[`Consumable`](../../mozilla.components.support.base.observer/-consumable/index.md)`<`[`PromptRequest`](../../mozilla.components.concept.engine.prompt/-prompt-request/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L295) + +[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) State for a prompt request from web content. + +**Getter** + +[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) State for a prompt request from web content. + +**Setter** + +[Consumable](../../mozilla.components.support.base.observer/-consumable/index.md) State for a prompt request from web content. + diff --git a/docs/api/mozilla.components.browser.session/-session/search-terms.md b/docs/api/mozilla.components.browser.session/-session/search-terms.md new file mode 100644 index 00000000000..69109070cc3 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/search-terms.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [searchTerms](./search-terms.md) + +# searchTerms + +`var searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L184) + +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/mozilla.components.browser.session/-session/security-info.md b/docs/api/mozilla.components.browser.session/-session/security-info.md new file mode 100644 index 00000000000..902c055a405 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/security-info.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [securityInfo](./security-info.md) + +# securityInfo + +`var securityInfo: `[`SecurityInfo`](-security-info/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L192) + +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/mozilla.components.browser.session/-session/source.md b/docs/api/mozilla.components.browser.session/-session/source.md new file mode 100644 index 00000000000..a482f60ae26 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/source.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [source](./source.md) + +# source + +`val source: `[`Source`](-source/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L27) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/thumbnail.md b/docs/api/mozilla.components.browser.session/-session/thumbnail.md new file mode 100644 index 00000000000..6171a00bd0c --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/thumbnail.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [thumbnail](./thumbnail.md) + +# thumbnail + +`var thumbnail: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L251) + +The target of the latest thumbnail. + +**Getter** + +The target of the latest thumbnail. + +**Setter** + +The target of the latest thumbnail. + diff --git a/docs/api/mozilla.components.browser.session/-session/title.md b/docs/api/mozilla.components.browser.session/-session/title.md new file mode 100644 index 00000000000..35ff9ba7a97 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/title.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [title](./title.md) + +# title + +`var title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L149) + +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/mozilla.components.browser.session/-session/to-string.md b/docs/api/mozilla.components.browser.session/-session/to-string.md new file mode 100644 index 00000000000..f4b27a14c9b --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/to-string.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [toString](./to-string.md) + +# toString + +`fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L346) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.session/-session/tracker-blocking-enabled.md b/docs/api/mozilla.components.browser.session/-session/tracker-blocking-enabled.md new file mode 100644 index 00000000000..0f9ce97eee9 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/tracker-blocking-enabled.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [trackerBlockingEnabled](./tracker-blocking-enabled.md) + +# trackerBlockingEnabled + +`var trackerBlockingEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L214) + +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/mozilla.components.browser.session/-session/trackers-blocked.md b/docs/api/mozilla.components.browser.session/-session/trackers-blocked.md new file mode 100644 index 00000000000..d06b0d2a783 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/trackers-blocked.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [trackersBlocked](./trackers-blocked.md) + +# 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)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L221) + +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/mozilla.components.browser.session/-session/url.md b/docs/api/mozilla.components.browser.session/-session/url.md new file mode 100644 index 00000000000..def5c01a399 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/-session/url.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.session](../index.md) / [Session](index.md) / [url](./url.md) + +# url + +`var url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/Session.kt#L142) + +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/mozilla.components.browser.session/index.md b/docs/api/mozilla.components.browser.session/index.md new file mode 100644 index 00000000000..8f6072215d8 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/index.md @@ -0,0 +1,18 @@ +[android-components](../index.md) / [mozilla.components.browser.session](./index.md) + +## Package mozilla.components.browser.session + +### Types + +| Name | Summary | +|---|---| +| [Download](-download/index.md) | `data class Download`
Value type that represents a Download. | +| [SelectionAwareSessionObserver](-selection-aware-session-observer/index.md) | `abstract class SelectionAwareSessionObserver : `[`Observer`](-session-manager/-observer/index.md)`, `[`Observer`](-session/-observer/index.md)
This class is a combination of [Session.Observer](-session/-observer/index.md) and [SessionManager.Observer](-session-manager/-observer/index.md). It provides functionality to observe changes to a specified or selected session, and can automatically take care of switching over the observer in case a different session gets selected (see [observeFixed](-selection-aware-session-observer/observe-fixed.md) and [observeSelected](-selection-aware-session-observer/observe-selected.md)). | +| [Session](-session/index.md) | `class Session : `[`Observable`](../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](-session/-observer/index.md)`>`
Value type that represents the state of a browser session. Changes can be observed. | +| [SessionManager](-session-manager/index.md) | `class SessionManager : `[`Observable`](../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](-session-manager/-observer/index.md)`>`
This class provides access to a centralized registry of all active sessions. | + +### Functions + +| Name | Summary | +|---|---| +| [runWithSession](run-with-session.md) | `fun `[`SessionManager`](-session-manager/index.md)`.runWithSession(sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, block: `[`SessionManager`](-session-manager/index.md)`.(`[`Session`](-session/index.md)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Tries to find a session with the provided session ID and runs the block if found. | diff --git a/docs/api/mozilla.components.browser.session/run-with-session.md b/docs/api/mozilla.components.browser.session/run-with-session.md new file mode 100644 index 00000000000..91981f9fe96 --- /dev/null +++ b/docs/api/mozilla.components.browser.session/run-with-session.md @@ -0,0 +1,11 @@ +[android-components](../index.md) / [mozilla.components.browser.session](index.md) / [runWithSession](./run-with-session.md) + +# runWithSession + +`fun `[`SessionManager`](-session-manager/index.md)`.runWithSession(sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, block: `[`SessionManager`](-session-manager/index.md)`.(`[`Session`](-session/index.md)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/session/src/main/java/mozilla/components/browser/session/SessionManager.kt#L541) + +Tries to find a session with the provided session ID and runs the block if found. + +**Return** +True if the session was found and run successfully. + diff --git a/docs/api/mozilla.components.browser.storage.memory/-a-u-t-o-c-o-m-p-l-e-t-e_-s-o-u-r-c-e_-n-a-m-e.md b/docs/api/mozilla.components.browser.storage.memory/-a-u-t-o-c-o-m-p-l-e-t-e_-s-o-u-r-c-e_-n-a-m-e.md new file mode 100644 index 00000000000..1db3192a8e4 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.memory/-a-u-t-o-c-o-m-p-l-e-t-e_-s-o-u-r-c-e_-n-a-m-e.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.browser.storage.memory](index.md) / [AUTOCOMPLETE_SOURCE_NAME](./-a-u-t-o-c-o-m-p-l-e-t-e_-s-o-u-r-c-e_-n-a-m-e.md) + +# AUTOCOMPLETE_SOURCE_NAME + +`const val AUTOCOMPLETE_SOURCE_NAME: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-memory/src/main/java/mozilla/components/browser/storage/memory/InMemoryHistoryStorage.kt#L17) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/-init-.md b/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/-init-.md new file mode 100644 index 00000000000..4296e3c00f8 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.memory](../index.md) / [InMemoryHistoryStorage](index.md) / [<init>](./-init-.md) + +# <init> + +`InMemoryHistoryStorage()` + +An in-memory implementation of [mozilla.components.concept.storage.HistoryStorage](../../mozilla.components.concept.storage/-history-storage/index.md). + diff --git a/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/cleanup.md b/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/cleanup.md new file mode 100644 index 00000000000..4ef1bb44df3 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/cleanup.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.memory](../index.md) / [InMemoryHistoryStorage](index.md) / [cleanup](./cleanup.md) + +# cleanup + +`fun cleanup(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-memory/src/main/java/mozilla/components/browser/storage/memory/InMemoryHistoryStorage.kt#L130) + +Overrides [HistoryStorage.cleanup](../../mozilla.components.concept.storage/-history-storage/cleanup.md) + +Cleanup any allocated resources. + diff --git a/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/get-autocomplete-suggestion.md b/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/get-autocomplete-suggestion.md new file mode 100644 index 00000000000..396316df69c --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/get-autocomplete-suggestion.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.memory](../index.md) / [InMemoryHistoryStorage](index.md) / [getAutocompleteSuggestion](./get-autocomplete-suggestion.md) + +# getAutocompleteSuggestion + +`fun getAutocompleteSuggestion(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`HistoryAutocompleteResult`](../../mozilla.components.concept.storage/-history-autocomplete-result/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-memory/src/main/java/mozilla/components/browser/storage/memory/InMemoryHistoryStorage.kt#L85) + +Overrides [HistoryStorage.getAutocompleteSuggestion](../../mozilla.components.concept.storage/-history-storage/get-autocomplete-suggestion.md) + +Retrieves domain suggestions which best match the [query](get-autocomplete-suggestion.md#mozilla.components.browser.storage.memory.InMemoryHistoryStorage$getAutocompleteSuggestion(kotlin.String)/query). + +### Parameters + +`query` - A query by which to search the underlying store. + +**Return** +An optional domain URL which best matches the query. + diff --git a/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/get-suggestions.md b/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/get-suggestions.md new file mode 100644 index 00000000000..cc08cc475c1 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/get-suggestions.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.memory](../index.md) / [InMemoryHistoryStorage](index.md) / [getSuggestions](./get-suggestions.md) + +# getSuggestions + +`fun getSuggestions(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, limit: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchResult`](../../mozilla.components.concept.storage/-search-result/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-memory/src/main/java/mozilla/components/browser/storage/memory/InMemoryHistoryStorage.kt#L57) + +Overrides [HistoryStorage.getSuggestions](../../mozilla.components.concept.storage/-history-storage/get-suggestions.md) + +Retrieves suggestions matching the [query](get-suggestions.md#mozilla.components.browser.storage.memory.InMemoryHistoryStorage$getSuggestions(kotlin.String, kotlin.Int)/query). + +### Parameters + +`query` - A query by which to search the underlying store. + +**Return** +A List of [SearchResult](../../mozilla.components.concept.storage/-search-result/index.md) matching the query, in no particular order. + diff --git a/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/get-visited.md b/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/get-visited.md new file mode 100644 index 00000000000..1568ebc0749 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/get-visited.md @@ -0,0 +1,27 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.memory](../index.md) / [InMemoryHistoryStorage](index.md) / [getVisited](./get-visited.md) + +# getVisited + +`suspend fun getVisited(uris: `[`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`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-memory/src/main/java/mozilla/components/browser/storage/memory/InMemoryHistoryStorage.kt#L44) + +Overrides [HistoryStorage.getVisited](../../mozilla.components.concept.storage/-history-storage/get-visited.md) + +Maps a list of page URIs to a list of booleans indicating if each URI was visited. + +### Parameters + +`uris` - a list of page URIs about which "visited" information is being requested. + +**Return** +A list of booleans indicating visited status of each +corresponding page URI from [uris](get-visited.md#mozilla.components.browser.storage.memory.InMemoryHistoryStorage$getVisited(kotlin.collections.List((kotlin.String)))/uris). + +`suspend fun getVisited(): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-memory/src/main/java/mozilla/components/browser/storage/memory/InMemoryHistoryStorage.kt#L53) + +Overrides [HistoryStorage.getVisited](../../mozilla.components.concept.storage/-history-storage/get-visited.md) + +Retrieves a list of all visited pages. + +**Return** +A list of all visited page URIs. + diff --git a/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/index.md b/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/index.md new file mode 100644 index 00000000000..0c364e3ad70 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/index.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.memory](../index.md) / [InMemoryHistoryStorage](./index.md) + +# InMemoryHistoryStorage + +`class InMemoryHistoryStorage : `[`HistoryStorage`](../../mozilla.components.concept.storage/-history-storage/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-memory/src/main/java/mozilla/components/browser/storage/memory/InMemoryHistoryStorage.kt#L22) + +An in-memory implementation of [mozilla.components.concept.storage.HistoryStorage](../../mozilla.components.concept.storage/-history-storage/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `InMemoryHistoryStorage()`
An in-memory implementation of [mozilla.components.concept.storage.HistoryStorage](../../mozilla.components.concept.storage/-history-storage/index.md). | + +### Functions + +| Name | Summary | +|---|---| +| [cleanup](cleanup.md) | `fun cleanup(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Cleanup any allocated resources. | +| [getAutocompleteSuggestion](get-autocomplete-suggestion.md) | `fun getAutocompleteSuggestion(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`HistoryAutocompleteResult`](../../mozilla.components.concept.storage/-history-autocomplete-result/index.md)`?`
Retrieves domain suggestions which best match the [query](get-autocomplete-suggestion.md#mozilla.components.browser.storage.memory.InMemoryHistoryStorage$getAutocompleteSuggestion(kotlin.String)/query). | +| [getSuggestions](get-suggestions.md) | `fun getSuggestions(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, limit: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchResult`](../../mozilla.components.concept.storage/-search-result/index.md)`>`
Retrieves suggestions matching the [query](get-suggestions.md#mozilla.components.browser.storage.memory.InMemoryHistoryStorage$getSuggestions(kotlin.String, kotlin.Int)/query). | +| [getVisited](get-visited.md) | `suspend fun getVisited(uris: `[`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`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>`
Maps a list of page URIs to a list of booleans indicating if each URI was visited.`suspend fun getVisited(): `[`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)`>`
Retrieves a list of all visited pages. | +| [recordObservation](record-observation.md) | `suspend fun recordObservation(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, observation: `[`PageObservation`](../../mozilla.components.concept.storage/-page-observation/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Records an observation about a page. | +| [recordVisit](record-visit.md) | `suspend fun recordVisit(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, visitType: `[`VisitType`](../../mozilla.components.concept.storage/-visit-type/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Records a visit to a page. | diff --git a/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/record-observation.md b/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/record-observation.md new file mode 100644 index 00000000000..fb06d39cbcc --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/record-observation.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.memory](../index.md) / [InMemoryHistoryStorage](index.md) / [recordObservation](./record-observation.md) + +# recordObservation + +`suspend fun recordObservation(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, observation: `[`PageObservation`](../../mozilla.components.concept.storage/-page-observation/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-memory/src/main/java/mozilla/components/browser/storage/memory/InMemoryHistoryStorage.kt#L40) + +Overrides [HistoryStorage.recordObservation](../../mozilla.components.concept.storage/-history-storage/record-observation.md) + +Records an observation about a page. + +### Parameters + +`uri` - of the page for which to record an observation. + +`observation` - a [PageObservation](../../mozilla.components.concept.storage/-page-observation/index.md) which encapsulates meta data observed about the page. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/record-visit.md b/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/record-visit.md new file mode 100644 index 00000000000..361af413a9b --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.memory/-in-memory-history-storage/record-visit.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.memory](../index.md) / [InMemoryHistoryStorage](index.md) / [recordVisit](./record-visit.md) + +# recordVisit + +`suspend fun recordVisit(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, visitType: `[`VisitType`](../../mozilla.components.concept.storage/-visit-type/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-memory/src/main/java/mozilla/components/browser/storage/memory/InMemoryHistoryStorage.kt#L28) + +Overrides [HistoryStorage.recordVisit](../../mozilla.components.concept.storage/-history-storage/record-visit.md) + +Records a visit to a page. + +### Parameters + +`uri` - of the page which was visited. + +`visitType` - type of the visit, see [VisitType](../../mozilla.components.concept.storage/-visit-type/index.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.storage.memory/-visit/-init-.md b/docs/api/mozilla.components.browser.storage.memory/-visit/-init-.md new file mode 100644 index 00000000000..cc96d3df790 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.memory/-visit/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.memory](../index.md) / [Visit](index.md) / [<init>](./-init-.md) + +# <init> + +`Visit(timestamp: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, type: `[`VisitType`](../../mozilla.components.concept.storage/-visit-type/index.md)`)` \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.storage.memory/-visit/index.md b/docs/api/mozilla.components.browser.storage.memory/-visit/index.md new file mode 100644 index 00000000000..59939bb7461 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.memory/-visit/index.md @@ -0,0 +1,18 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.memory](../index.md) / [Visit](./index.md) + +# Visit + +`data class Visit` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-memory/src/main/java/mozilla/components/browser/storage/memory/InMemoryHistoryStorage.kt#L15) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Visit(timestamp: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, type: `[`VisitType`](../../mozilla.components.concept.storage/-visit-type/index.md)`)` | + +### Properties + +| Name | Summary | +|---|---| +| [timestamp](timestamp.md) | `val timestamp: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | +| [type](type.md) | `val type: `[`VisitType`](../../mozilla.components.concept.storage/-visit-type/index.md) | diff --git a/docs/api/mozilla.components.browser.storage.memory/-visit/timestamp.md b/docs/api/mozilla.components.browser.storage.memory/-visit/timestamp.md new file mode 100644 index 00000000000..f601aa8602e --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.memory/-visit/timestamp.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.memory](../index.md) / [Visit](index.md) / [timestamp](./timestamp.md) + +# timestamp + +`val timestamp: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-memory/src/main/java/mozilla/components/browser/storage/memory/InMemoryHistoryStorage.kt#L15) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.storage.memory/-visit/type.md b/docs/api/mozilla.components.browser.storage.memory/-visit/type.md new file mode 100644 index 00000000000..3e379ca5f65 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.memory/-visit/type.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.memory](../index.md) / [Visit](index.md) / [type](./type.md) + +# type + +`val type: `[`VisitType`](../../mozilla.components.concept.storage/-visit-type/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-memory/src/main/java/mozilla/components/browser/storage/memory/InMemoryHistoryStorage.kt#L15) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.storage.memory/index.md b/docs/api/mozilla.components.browser.storage.memory/index.md new file mode 100644 index 00000000000..194e4a4cfc5 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.memory/index.md @@ -0,0 +1,16 @@ +[android-components](../index.md) / [mozilla.components.browser.storage.memory](./index.md) + +## Package mozilla.components.browser.storage.memory + +### Types + +| Name | Summary | +|---|---| +| [InMemoryHistoryStorage](-in-memory-history-storage/index.md) | `class InMemoryHistoryStorage : `[`HistoryStorage`](../mozilla.components.concept.storage/-history-storage/index.md)
An in-memory implementation of [mozilla.components.concept.storage.HistoryStorage](../mozilla.components.concept.storage/-history-storage/index.md). | +| [Visit](-visit/index.md) | `data class Visit` | + +### Properties + +| Name | Summary | +|---|---| +| [AUTOCOMPLETE_SOURCE_NAME](-a-u-t-o-c-o-m-p-l-e-t-e_-s-o-u-r-c-e_-n-a-m-e.md) | `const val AUTOCOMPLETE_SOURCE_NAME: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.browser.storage.sync/-a-u-t-o-c-o-m-p-l-e-t-e_-s-o-u-r-c-e_-n-a-m-e.md b/docs/api/mozilla.components.browser.storage.sync/-a-u-t-o-c-o-m-p-l-e-t-e_-s-o-u-r-c-e_-n-a-m-e.md new file mode 100644 index 00000000000..7b21661b346 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.sync/-a-u-t-o-c-o-m-p-l-e-t-e_-s-o-u-r-c-e_-n-a-m-e.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.browser.storage.sync](index.md) / [AUTOCOMPLETE_SOURCE_NAME](./-a-u-t-o-c-o-m-p-l-e-t-e_-s-o-u-r-c-e_-n-a-m-e.md) + +# AUTOCOMPLETE_SOURCE_NAME + +`const val AUTOCOMPLETE_SOURCE_NAME: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-sync/src/main/java/mozilla/components/browser/storage/sync/PlacesHistoryStorage.kt#L29) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.storage.sync/-connection/api.md b/docs/api/mozilla.components.browser.storage.sync/-connection/api.md new file mode 100644 index 00000000000..27c955000c9 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.sync/-connection/api.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.sync](../index.md) / [Connection](index.md) / [api](./api.md) + +# api + +`abstract fun api(): PlacesAPI` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-sync/src/main/java/mozilla/components/browser/storage/sync/Connection.kt#L57) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.storage.sync/-connection/index.md b/docs/api/mozilla.components.browser.storage.sync/-connection/index.md new file mode 100644 index 00000000000..88adf3a5995 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.sync/-connection/index.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.sync](../index.md) / [Connection](./index.md) + +# Connection + +`interface Connection : `[`Closeable`](https://developer.android.com/reference/java/io/Closeable.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-sync/src/main/java/mozilla/components/browser/storage/sync/Connection.kt#L56) + +An interface which describes a [Closeable](https://developer.android.com/reference/java/io/Closeable.html) connection that provides access to a [PlacesAPI](#). + +### Functions + +| Name | Summary | +|---|---| +| [api](api.md) | `abstract fun api(): PlacesAPI` | diff --git a/docs/api/mozilla.components.browser.storage.sync/-d-b_-n-a-m-e.md b/docs/api/mozilla.components.browser.storage.sync/-d-b_-n-a-m-e.md new file mode 100644 index 00000000000..5385bb51ed0 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.sync/-d-b_-n-a-m-e.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.browser.storage.sync](index.md) / [DB_NAME](./-d-b_-n-a-m-e.md) + +# DB_NAME + +`const val DB_NAME: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-sync/src/main/java/mozilla/components/browser/storage/sync/Connection.kt#L13) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/-init-.md b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/-init-.md new file mode 100644 index 00000000000..e006748b585 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.sync](../index.md) / [PlacesHistoryStorage](index.md) / [<init>](./-init-.md) + +# <init> + +`PlacesHistoryStorage(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`)` + +Implementation of the [HistoryStorage](../../mozilla.components.concept.storage/-history-storage/index.md) which is backed by a Rust Places lib via [PlacesConnection](#). + diff --git a/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/cleanup.md b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/cleanup.md new file mode 100644 index 00000000000..3abd7356673 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/cleanup.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.sync](../index.md) / [PlacesHistoryStorage](index.md) / [cleanup](./cleanup.md) + +# cleanup + +`open fun cleanup(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-sync/src/main/java/mozilla/components/browser/storage/sync/PlacesHistoryStorage.kt#L79) + +Overrides [HistoryStorage.cleanup](../../mozilla.components.concept.storage/-history-storage/cleanup.md) + +Cleanup any allocated resources. + diff --git a/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/get-autocomplete-suggestion.md b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/get-autocomplete-suggestion.md new file mode 100644 index 00000000000..9140c49b1a6 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/get-autocomplete-suggestion.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.sync](../index.md) / [PlacesHistoryStorage](index.md) / [getAutocompleteSuggestion](./get-autocomplete-suggestion.md) + +# getAutocompleteSuggestion + +`open fun getAutocompleteSuggestion(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`HistoryAutocompleteResult`](../../mozilla.components.concept.storage/-history-autocomplete-result/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-sync/src/main/java/mozilla/components/browser/storage/sync/PlacesHistoryStorage.kt#L91) + +Overrides [HistoryStorage.getAutocompleteSuggestion](../../mozilla.components.concept.storage/-history-storage/get-autocomplete-suggestion.md) + +Retrieves domain suggestions which best match the [query](get-autocomplete-suggestion.md#mozilla.components.browser.storage.sync.PlacesHistoryStorage$getAutocompleteSuggestion(kotlin.String)/query). + +### Parameters + +`query` - A query by which to search the underlying store. + +**Return** +An optional domain URL which best matches the query. + diff --git a/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/get-suggestions.md b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/get-suggestions.md new file mode 100644 index 00000000000..18362b61cdd --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/get-suggestions.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.sync](../index.md) / [PlacesHistoryStorage](index.md) / [getSuggestions](./get-suggestions.md) + +# getSuggestions + +`open fun getSuggestions(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, limit: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchResult`](../../mozilla.components.concept.storage/-search-result/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-sync/src/main/java/mozilla/components/browser/storage/sync/PlacesHistoryStorage.kt#L84) + +Overrides [HistoryStorage.getSuggestions](../../mozilla.components.concept.storage/-history-storage/get-suggestions.md) + +Retrieves suggestions matching the [query](get-suggestions.md#mozilla.components.browser.storage.sync.PlacesHistoryStorage$getSuggestions(kotlin.String, kotlin.Int)/query). + +### Parameters + +`query` - A query by which to search the underlying store. + +**Return** +A List of [SearchResult](../../mozilla.components.concept.storage/-search-result/index.md) matching the query, in no particular order. + diff --git a/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/get-visited.md b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/get-visited.md new file mode 100644 index 00000000000..ebd1c57c2ad --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/get-visited.md @@ -0,0 +1,27 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.sync](../index.md) / [PlacesHistoryStorage](index.md) / [getVisited](./get-visited.md) + +# getVisited + +`open suspend fun getVisited(uris: `[`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`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-sync/src/main/java/mozilla/components/browser/storage/sync/PlacesHistoryStorage.kt#L65) + +Overrides [HistoryStorage.getVisited](../../mozilla.components.concept.storage/-history-storage/get-visited.md) + +Maps a list of page URIs to a list of booleans indicating if each URI was visited. + +### Parameters + +`uris` - a list of page URIs about which "visited" information is being requested. + +**Return** +A list of booleans indicating visited status of each +corresponding page URI from [uris](get-visited.md#mozilla.components.browser.storage.sync.PlacesHistoryStorage$getVisited(kotlin.collections.List((kotlin.String)))/uris). + +`open suspend fun getVisited(): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-sync/src/main/java/mozilla/components/browser/storage/sync/PlacesHistoryStorage.kt#L69) + +Overrides [HistoryStorage.getVisited](../../mozilla.components.concept.storage/-history-storage/get-visited.md) + +Retrieves a list of all visited pages. + +**Return** +A list of all visited page URIs. + diff --git a/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/index.md b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/index.md new file mode 100644 index 00000000000..0eb0963bf46 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.sync](../index.md) / [PlacesHistoryStorage](./index.md) + +# PlacesHistoryStorage + +`open class PlacesHistoryStorage : `[`HistoryStorage`](../../mozilla.components.concept.storage/-history-storage/index.md)`, `[`SyncableStore`](../../mozilla.components.concept.storage/-syncable-store/index.md)`` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-sync/src/main/java/mozilla/components/browser/storage/sync/PlacesHistoryStorage.kt#L36) + +Implementation of the [HistoryStorage](../../mozilla.components.concept.storage/-history-storage/index.md) which is backed by a Rust Places lib via [PlacesConnection](#). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `PlacesHistoryStorage(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`)`
Implementation of the [HistoryStorage](../../mozilla.components.concept.storage/-history-storage/index.md) which is backed by a Rust Places lib via [PlacesConnection](#). | + +### Functions + +| Name | Summary | +|---|---| +| [cleanup](cleanup.md) | `open fun cleanup(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Cleanup any allocated resources. | +| [getAutocompleteSuggestion](get-autocomplete-suggestion.md) | `open fun getAutocompleteSuggestion(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`HistoryAutocompleteResult`](../../mozilla.components.concept.storage/-history-autocomplete-result/index.md)`?`
Retrieves domain suggestions which best match the [query](get-autocomplete-suggestion.md#mozilla.components.browser.storage.sync.PlacesHistoryStorage$getAutocompleteSuggestion(kotlin.String)/query). | +| [getSuggestions](get-suggestions.md) | `open fun getSuggestions(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, limit: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchResult`](../../mozilla.components.concept.storage/-search-result/index.md)`>`
Retrieves suggestions matching the [query](get-suggestions.md#mozilla.components.browser.storage.sync.PlacesHistoryStorage$getSuggestions(kotlin.String, kotlin.Int)/query). | +| [getVisited](get-visited.md) | `open suspend fun getVisited(uris: `[`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`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>`
Maps a list of page URIs to a list of booleans indicating if each URI was visited.`open suspend fun getVisited(): `[`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)`>`
Retrieves a list of all visited pages. | +| [recordObservation](record-observation.md) | `open suspend fun recordObservation(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, observation: `[`PageObservation`](../../mozilla.components.concept.storage/-page-observation/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Records an observation about a page. | +| [recordVisit](record-visit.md) | `open suspend fun recordVisit(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, visitType: `[`VisitType`](../../mozilla.components.concept.storage/-visit-type/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Records a visit to a page. | +| [sync](sync.md) | `open suspend fun sync(authInfo: SyncAuthInfo): `[`SyncStatus`](../../mozilla.components.concept.storage/-sync-status.md)
Performs a sync. | diff --git a/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/record-observation.md b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/record-observation.md new file mode 100644 index 00000000000..d79d309c260 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/record-observation.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.sync](../index.md) / [PlacesHistoryStorage](index.md) / [recordObservation](./record-observation.md) + +# recordObservation + +`open suspend fun recordObservation(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, observation: `[`PageObservation`](../../mozilla.components.concept.storage/-page-observation/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-sync/src/main/java/mozilla/components/browser/storage/sync/PlacesHistoryStorage.kt#L52) + +Overrides [HistoryStorage.recordObservation](../../mozilla.components.concept.storage/-history-storage/record-observation.md) + +Records an observation about a page. + +### Parameters + +`uri` - of the page for which to record an observation. + +`observation` - a [PageObservation](../../mozilla.components.concept.storage/-page-observation/index.md) which encapsulates meta data observed about the page. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/record-visit.md b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/record-visit.md new file mode 100644 index 00000000000..0c39fc7fb66 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/record-visit.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.sync](../index.md) / [PlacesHistoryStorage](index.md) / [recordVisit](./record-visit.md) + +# recordVisit + +`open suspend fun recordVisit(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, visitType: `[`VisitType`](../../mozilla.components.concept.storage/-visit-type/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-sync/src/main/java/mozilla/components/browser/storage/sync/PlacesHistoryStorage.kt#L46) + +Overrides [HistoryStorage.recordVisit](../../mozilla.components.concept.storage/-history-storage/record-visit.md) + +Records a visit to a page. + +### Parameters + +`uri` - of the page which was visited. + +`visitType` - type of the visit, see [VisitType](../../mozilla.components.concept.storage/-visit-type/index.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/sync.md b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/sync.md new file mode 100644 index 00000000000..369153d32e1 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.sync/-places-history-storage/sync.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.browser.storage.sync](../index.md) / [PlacesHistoryStorage](index.md) / [sync](./sync.md) + +# sync + +`open suspend fun sync(authInfo: SyncAuthInfo): `[`SyncStatus`](../../mozilla.components.concept.storage/-sync-status.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-sync/src/main/java/mozilla/components/browser/storage/sync/PlacesHistoryStorage.kt#L106) + +Overrides [SyncableStore.sync](../../mozilla.components.concept.storage/-syncable-store/sync.md) + +Performs a sync. + +### Parameters + +`authInfo` - Auth information of type [AuthInfo](#) necessary for syncing this store. + +**Return** +[SyncStatus](../../mozilla.components.concept.storage/-sync-status.md) A status object describing how sync went. + diff --git a/docs/api/mozilla.components.browser.storage.sync/-sync-auth-info.md b/docs/api/mozilla.components.browser.storage.sync/-sync-auth-info.md new file mode 100644 index 00000000000..3a8f470b5dd --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.sync/-sync-auth-info.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.browser.storage.sync](index.md) / [SyncAuthInfo](./-sync-auth-info.md) + +# SyncAuthInfo + +`typealias SyncAuthInfo = SyncAuthInfo` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/storage-sync/src/main/java/mozilla/components/browser/storage/sync/PlacesHistoryStorage.kt#L31) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.storage.sync/index.md b/docs/api/mozilla.components.browser.storage.sync/index.md new file mode 100644 index 00000000000..68b9091cf07 --- /dev/null +++ b/docs/api/mozilla.components.browser.storage.sync/index.md @@ -0,0 +1,23 @@ +[android-components](../index.md) / [mozilla.components.browser.storage.sync](./index.md) + +## Package mozilla.components.browser.storage.sync + +### Types + +| Name | Summary | +|---|---| +| [Connection](-connection/index.md) | `interface Connection : `[`Closeable`](https://developer.android.com/reference/java/io/Closeable.html)
An interface which describes a [Closeable](https://developer.android.com/reference/java/io/Closeable.html) connection that provides access to a [PlacesAPI](#). | +| [PlacesHistoryStorage](-places-history-storage/index.md) | `open class PlacesHistoryStorage : `[`HistoryStorage`](../mozilla.components.concept.storage/-history-storage/index.md)`, `[`SyncableStore`](../mozilla.components.concept.storage/-syncable-store/index.md)``
Implementation of the [HistoryStorage](../mozilla.components.concept.storage/-history-storage/index.md) which is backed by a Rust Places lib via [PlacesConnection](#). | + +### Type Aliases + +| Name | Summary | +|---|---| +| [SyncAuthInfo](-sync-auth-info.md) | `typealias SyncAuthInfo = SyncAuthInfo` | + +### Properties + +| Name | Summary | +|---|---| +| [AUTOCOMPLETE_SOURCE_NAME](-a-u-t-o-c-o-m-p-l-e-t-e_-s-o-u-r-c-e_-n-a-m-e.md) | `const val AUTOCOMPLETE_SOURCE_NAME: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [DB_NAME](-d-b_-n-a-m-e.md) | `const val DB_NAME: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.browser.tabstray/-browser-tabs-tray/-init-.md b/docs/api/mozilla.components.browser.tabstray/-browser-tabs-tray/-init-.md new file mode 100644 index 00000000000..77e72ca63c7 --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-browser-tabs-tray/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [BrowserTabsTray](index.md) / [<init>](./-init-.md) + +# <init> + +`BrowserTabsTray(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0, tabsAdapter: `[`TabsAdapter`](../-tabs-adapter/index.md)` = TabsAdapter())` + +A customizable tabs tray for browsers. + diff --git a/docs/api/mozilla.components.browser.tabstray/-browser-tabs-tray/as-view.md b/docs/api/mozilla.components.browser.tabstray/-browser-tabs-tray/as-view.md new file mode 100644 index 00000000000..89fa8a7e2c7 --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-browser-tabs-tray/as-view.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [BrowserTabsTray](index.md) / [asView](./as-view.md) + +# asView + +`fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/BrowserTabsTray.kt#L62) + +Overrides [TabsTray.asView](../../mozilla.components.concept.tabstray/-tabs-tray/as-view.md) + +Convenience method to cast this object to an Android View object. + diff --git a/docs/api/mozilla.components.browser.tabstray/-browser-tabs-tray/index.md b/docs/api/mozilla.components.browser.tabstray/-browser-tabs-tray/index.md new file mode 100644 index 00000000000..4f0dee0cb8a --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-browser-tabs-tray/index.md @@ -0,0 +1,39 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [BrowserTabsTray](./index.md) + +# BrowserTabsTray + +`class BrowserTabsTray : RecyclerView, `[`TabsTray`](../../mozilla.components.concept.tabstray/-tabs-tray/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/BrowserTabsTray.kt#L22) + +A customizable tabs tray for browsers. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `BrowserTabsTray(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0, tabsAdapter: `[`TabsAdapter`](../-tabs-adapter/index.md)` = TabsAdapter())`
A customizable tabs tray for browsers. | + +### Functions + +| Name | Summary | +|---|---| +| [asView](as-view.md) | `fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html)
Convenience method to cast this object to an Android View object. | +| [onDetachedFromWindow](on-detached-from-window.md) | `fun onDetachedFromWindow(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Extension Properties + +| Name | Summary | +|---|---| +| [isLTR](../../mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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? | + +### Extension Functions + +| Name | Summary | +|---|---| +| [forEach](../../mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md) | `fun `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`.forEach(action: (`[`View`](https://developer.android.com/reference/android/view/View.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 the given action on each View in this ViewGroup. | +| [hideKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.hideKeyboard(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Hides the soft input window. | +| [isGone](../../mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [isVisible](../../mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [setPadding](../../mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.setPadding(padding: `[`Padding`](../../mozilla.components.support.base.android/-padding/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Set a padding using [Padding](../../mozilla.components.support.base.android/-padding/index.md) object. | +| [showKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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/mozilla.components.browser.tabstray/-browser-tabs-tray/on-detached-from-window.md b/docs/api/mozilla.components.browser.tabstray/-browser-tabs-tray/on-detached-from-window.md new file mode 100644 index 00000000000..1a3d0cdbe4a --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-browser-tabs-tray/on-detached-from-window.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [BrowserTabsTray](index.md) / [onDetachedFromWindow](./on-detached-from-window.md) + +# onDetachedFromWindow + +`protected fun onDetachedFromWindow(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/BrowserTabsTray.kt#L50) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.tabstray/-d-e-f-a-u-l-t_-i-t-e-m_-b-a-c-k-g-r-o-u-n-d_-c-o-l-o-r.md b/docs/api/mozilla.components.browser.tabstray/-d-e-f-a-u-l-t_-i-t-e-m_-b-a-c-k-g-r-o-u-n-d_-c-o-l-o-r.md new file mode 100644 index 00000000000..735ec92503e --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-d-e-f-a-u-l-t_-i-t-e-m_-b-a-c-k-g-r-o-u-n-d_-c-o-l-o-r.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.browser.tabstray](index.md) / [DEFAULT_ITEM_BACKGROUND_COLOR](./-d-e-f-a-u-l-t_-i-t-e-m_-b-a-c-k-g-r-o-u-n-d_-c-o-l-o-r.md) + +# DEFAULT_ITEM_BACKGROUND_COLOR + +`const val DEFAULT_ITEM_BACKGROUND_COLOR: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/BrowserTabsTray.kt#L14) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.tabstray/-d-e-f-a-u-l-t_-i-t-e-m_-b-a-c-k-g-r-o-u-n-d_-s-e-l-e-c-t-e-d_-c-o-l-o-r.md b/docs/api/mozilla.components.browser.tabstray/-d-e-f-a-u-l-t_-i-t-e-m_-b-a-c-k-g-r-o-u-n-d_-s-e-l-e-c-t-e-d_-c-o-l-o-r.md new file mode 100644 index 00000000000..3008e8596d5 --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-d-e-f-a-u-l-t_-i-t-e-m_-b-a-c-k-g-r-o-u-n-d_-s-e-l-e-c-t-e-d_-c-o-l-o-r.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.browser.tabstray](index.md) / [DEFAULT_ITEM_BACKGROUND_SELECTED_COLOR](./-d-e-f-a-u-l-t_-i-t-e-m_-b-a-c-k-g-r-o-u-n-d_-s-e-l-e-c-t-e-d_-c-o-l-o-r.md) + +# DEFAULT_ITEM_BACKGROUND_SELECTED_COLOR + +`const val DEFAULT_ITEM_BACKGROUND_SELECTED_COLOR: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/BrowserTabsTray.kt#L15) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.tabstray/-d-e-f-a-u-l-t_-i-t-e-m_-t-e-x-t_-c-o-l-o-r.md b/docs/api/mozilla.components.browser.tabstray/-d-e-f-a-u-l-t_-i-t-e-m_-t-e-x-t_-c-o-l-o-r.md new file mode 100644 index 00000000000..41d16c977d9 --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-d-e-f-a-u-l-t_-i-t-e-m_-t-e-x-t_-c-o-l-o-r.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.browser.tabstray](index.md) / [DEFAULT_ITEM_TEXT_COLOR](./-d-e-f-a-u-l-t_-i-t-e-m_-t-e-x-t_-c-o-l-o-r.md) + +# DEFAULT_ITEM_TEXT_COLOR + +`const val DEFAULT_ITEM_TEXT_COLOR: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/BrowserTabsTray.kt#L16) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.tabstray/-d-e-f-a-u-l-t_-i-t-e-m_-t-e-x-t_-s-e-l-e-c-t-e-d_-c-o-l-o-r.md b/docs/api/mozilla.components.browser.tabstray/-d-e-f-a-u-l-t_-i-t-e-m_-t-e-x-t_-s-e-l-e-c-t-e-d_-c-o-l-o-r.md new file mode 100644 index 00000000000..1384f6a4e14 --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-d-e-f-a-u-l-t_-i-t-e-m_-t-e-x-t_-s-e-l-e-c-t-e-d_-c-o-l-o-r.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.browser.tabstray](index.md) / [DEFAULT_ITEM_TEXT_SELECTED_COLOR](./-d-e-f-a-u-l-t_-i-t-e-m_-t-e-x-t_-s-e-l-e-c-t-e-d_-c-o-l-o-r.md) + +# DEFAULT_ITEM_TEXT_SELECTED_COLOR + +`const val DEFAULT_ITEM_TEXT_SELECTED_COLOR: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/BrowserTabsTray.kt#L17) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.tabstray/-tab-view-holder/-init-.md b/docs/api/mozilla.components.browser.tabstray/-tab-view-holder/-init-.md new file mode 100644 index 00000000000..5fe99d634ac --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tab-view-holder/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabViewHolder](index.md) / [<init>](./-init-.md) + +# <init> + +`TabViewHolder(itemView: `[`View`](https://developer.android.com/reference/android/view/View.html)`, tabsTray: `[`BrowserTabsTray`](../-browser-tabs-tray/index.md)`)` + +A RecyclerView ViewHolder implementation for "tab" items. + diff --git a/docs/api/mozilla.components.browser.tabstray/-tab-view-holder/bind.md b/docs/api/mozilla.components.browser.tabstray/-tab-view-holder/bind.md new file mode 100644 index 00000000000..26ba49788a2 --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tab-view-holder/bind.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabViewHolder](index.md) / [bind](./bind.md) + +# bind + +`fun bind(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, isSelected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, observable: `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](../../mozilla.components.concept.tabstray/-tabs-tray/-observer/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/TabViewHolder.kt#L37) + +Displays the data of the given session and notifies the given observable about events. + diff --git a/docs/api/mozilla.components.browser.tabstray/-tab-view-holder/index.md b/docs/api/mozilla.components.browser.tabstray/-tab-view-holder/index.md new file mode 100644 index 00000000000..49e8c38dee5 --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tab-view-holder/index.md @@ -0,0 +1,46 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabViewHolder](./index.md) + +# TabViewHolder + +`class TabViewHolder : ViewHolder, `[`Observer`](../../mozilla.components.browser.session/-session/-observer/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/TabViewHolder.kt#L21) + +A RecyclerView ViewHolder implementation for "tab" items. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TabViewHolder(itemView: `[`View`](https://developer.android.com/reference/android/view/View.html)`, tabsTray: `[`BrowserTabsTray`](../-browser-tabs-tray/index.md)`)`
A RecyclerView ViewHolder implementation for "tab" items. | + +### Functions + +| Name | Summary | +|---|---| +| [bind](bind.md) | `fun bind(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, isSelected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, observable: `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](../../mozilla.components.concept.tabstray/-tabs-tray/-observer/index.md)`>): `[`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.md) | `fun onUrlChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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.md) | `fun unbind(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
The attached view no longer needs to display any data. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [onAppPermissionRequested](../../mozilla.components.browser.session/-session/-observer/on-app-permission-requested.md) | `open fun onAppPermissionRequested(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, permissionRequest: `[`PermissionRequest`](../../mozilla.components.concept.engine.permission/-permission-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onCloseWindowRequested](../../mozilla.components.browser.session/-session/-observer/on-close-window-requested.md) | `open fun onCloseWindowRequested(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, windowRequest: `[`WindowRequest`](../../mozilla.components.concept.engine.window/-window-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onContentPermissionRequested](../../mozilla.components.browser.session/-session/-observer/on-content-permission-requested.md) | `open fun onContentPermissionRequested(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, permissionRequest: `[`PermissionRequest`](../../mozilla.components.concept.engine.permission/-permission-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onCustomTabConfigChanged](../../mozilla.components.browser.session/-session/-observer/on-custom-tab-config-changed.md) | `open fun onCustomTabConfigChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, customTabConfig: `[`CustomTabConfig`](../../mozilla.components.browser.session.tab/-custom-tab-config/index.md)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onDesktopModeChanged](../../mozilla.components.browser.session/-session/-observer/on-desktop-mode-changed.md) | `open fun onDesktopModeChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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) | +| [onDownload](../../mozilla.components.browser.session/-session/-observer/on-download.md) | `open fun onDownload(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, download: `[`Download`](../../mozilla.components.browser.session/-download/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onFindResult](../../mozilla.components.browser.session/-session/-observer/on-find-result.md) | `open fun onFindResult(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, result: `[`FindResult`](../../mozilla.components.browser.session/-session/-find-result/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onFullScreenChanged](../../mozilla.components.browser.session/-session/-observer/on-full-screen-changed.md) | `open fun onFullScreenChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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) | +| [onLoadingStateChanged](../../mozilla.components.browser.session/-session/-observer/on-loading-state-changed.md) | `open fun onLoadingStateChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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](../../mozilla.components.browser.session/-session/-observer/on-long-press.md) | `open fun onLongPress(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, hitResult: `[`HitResult`](../../mozilla.components.concept.engine/-hit-result/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onNavigationStateChanged](../../mozilla.components.browser.session/-session/-observer/on-navigation-state-changed.md) | `open fun onNavigationStateChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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) | +| [onOpenWindowRequested](../../mozilla.components.browser.session/-session/-observer/on-open-window-requested.md) | `open fun onOpenWindowRequested(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, windowRequest: `[`WindowRequest`](../../mozilla.components.concept.engine.window/-window-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onProgress](../../mozilla.components.browser.session/-session/-observer/on-progress.md) | `open fun onProgress(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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) | +| [onPromptRequested](../../mozilla.components.browser.session/-session/-observer/on-prompt-requested.md) | `open fun onPromptRequested(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, promptRequest: `[`PromptRequest`](../../mozilla.components.concept.engine.prompt/-prompt-request/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onSearch](../../mozilla.components.browser.session/-session/-observer/on-search.md) | `open fun onSearch(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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](../../mozilla.components.browser.session/-session/-observer/on-security-changed.md) | `open fun onSecurityChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, securityInfo: `[`SecurityInfo`](../../mozilla.components.browser.session/-session/-security-info/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onThumbnailChanged](../../mozilla.components.browser.session/-session/-observer/on-thumbnail-changed.md) | `open fun onThumbnailChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, bitmap: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onTitleChanged](../../mozilla.components.browser.session/-session/-observer/on-title-changed.md) | `open fun onTitleChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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](../../mozilla.components.browser.session/-session/-observer/on-tracker-blocked.md) | `open fun onTrackerBlocked(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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](../../mozilla.components.browser.session/-session/-observer/on-tracker-blocking-enabled-changed.md) | `open fun onTrackerBlockingEnabledChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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) | diff --git a/docs/api/mozilla.components.browser.tabstray/-tab-view-holder/on-url-changed.md b/docs/api/mozilla.components.browser.tabstray/-tab-view-holder/on-url-changed.md new file mode 100644 index 00000000000..63ff537afc8 --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tab-view-holder/on-url-changed.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabViewHolder](index.md) / [onUrlChanged](./on-url-changed.md) + +# onUrlChanged + +`fun onUrlChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/TabViewHolder.kt#L76) + +Overrides [Observer.onUrlChanged](../../mozilla.components.browser.session/-session/-observer/on-url-changed.md) + diff --git a/docs/api/mozilla.components.browser.tabstray/-tab-view-holder/unbind.md b/docs/api/mozilla.components.browser.tabstray/-tab-view-holder/unbind.md new file mode 100644 index 00000000000..cef3c7c8c9d --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tab-view-holder/unbind.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabViewHolder](index.md) / [unbind](./unbind.md) + +# unbind + +`fun unbind(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/TabViewHolder.kt#L72) + +The attached view no longer needs to display any data. + diff --git a/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/-init-.md b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/-init-.md new file mode 100644 index 00000000000..ada64a9e0a0 --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabsAdapter](index.md) / [<init>](./-init-.md) + +# <init> + +`TabsAdapter(delegate: `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](../../mozilla.components.concept.tabstray/-tabs-tray/-observer/index.md)`> = ObserverRegistry())` + +RecyclerView adapter implementation to display a list/grid of tabs. + diff --git a/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/display-sessions.md b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/display-sessions.md new file mode 100644 index 00000000000..69d8ae8a368 --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/display-sessions.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabsAdapter](index.md) / [displaySessions](./display-sessions.md) + +# displaySessions + +`fun displaySessions(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Session`](../../mozilla.components.browser.session/-session/index.md)`>, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/TabsAdapter.kt#L58) + +Overrides [TabsTray.displaySessions](../../mozilla.components.concept.tabstray/-tabs-tray/display-sessions.md) + +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/mozilla.components.browser.tabstray/-tabs-adapter/get-item-count.md b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/get-item-count.md new file mode 100644 index 00000000000..82b2a0f2f43 --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/get-item-count.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabsAdapter](index.md) / [getItemCount](./get-item-count.md) + +# getItemCount + +`fun getItemCount(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/TabsAdapter.kt#L43) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/index.md b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/index.md new file mode 100644 index 00000000000..e8436c8da8c --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/index.md @@ -0,0 +1,35 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabsAdapter](./index.md) + +# TabsAdapter + +`class TabsAdapter : Adapter<`[`TabViewHolder`](../-tab-view-holder/index.md)`>, `[`TabsTray`](../../mozilla.components.concept.tabstray/-tabs-tray/index.md)`, `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](../../mozilla.components.concept.tabstray/-tabs-tray/-observer/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/TabsAdapter.kt#L19) + +RecyclerView adapter implementation to display a list/grid of tabs. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TabsAdapter(delegate: `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](../../mozilla.components.concept.tabstray/-tabs-tray/-observer/index.md)`> = ObserverRegistry())`
RecyclerView adapter implementation to display a list/grid of tabs. | + +### Functions + +| Name | Summary | +|---|---| +| [displaySessions](display-sessions.md) | `fun displaySessions(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Session`](../../mozilla.components.browser.session/-session/index.md)`>, 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. | +| [getItemCount](get-item-count.md) | `fun getItemCount(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [onBindViewHolder](on-bind-view-holder.md) | `fun onBindViewHolder(holder: `[`TabViewHolder`](../-tab-view-holder/index.md)`, 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.md) | `fun onCreateViewHolder(parent: `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`, viewType: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TabViewHolder`](../-tab-view-holder/index.md) | +| [onSessionMoved](on-session-moved.md) | `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.md) | `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.md) | `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.md) | `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. | +| [onViewRecycled](on-view-recycled.md) | `fun onViewRecycled(holder: `[`TabViewHolder`](../-tab-view-holder/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [unsubscribeHolders](unsubscribe-holders.md) | `fun unsubscribeHolders(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [updateSessions](update-sessions.md) | `fun updateSessions(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Session`](../../mozilla.components.browser.session/-session/index.md)`>, 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. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [asView](../../mozilla.components.concept.tabstray/-tabs-tray/as-view.md) | `open fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html)
Convenience method to cast the implementation of this interface to an Android View object. | diff --git a/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-bind-view-holder.md b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-bind-view-holder.md new file mode 100644 index 00000000000..82d83c42ea2 --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-bind-view-holder.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabsAdapter](index.md) / [onBindViewHolder](./on-bind-view-holder.md) + +# onBindViewHolder + +`fun onBindViewHolder(holder: `[`TabViewHolder`](../-tab-view-holder/index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/TabsAdapter.kt#L45) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-create-view-holder.md b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-create-view-holder.md new file mode 100644 index 00000000000..4f9cff20f50 --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-create-view-holder.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabsAdapter](index.md) / [onCreateViewHolder](./on-create-view-holder.md) + +# onCreateViewHolder + +`fun onCreateViewHolder(parent: `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`, viewType: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TabViewHolder`](../-tab-view-holder/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/TabsAdapter.kt#L31) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-session-moved.md b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-session-moved.md new file mode 100644 index 00000000000..c47be55bb8a --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-session-moved.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabsAdapter](index.md) / [onSessionMoved](./on-session-moved.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/TabsAdapter.kt#L75) + +Overrides [TabsTray.onSessionMoved](../../mozilla.components.concept.tabstray/-tabs-tray/on-session-moved.md) + +Called after updateSessions() when a session changes it position. + diff --git a/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-changed.md b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-changed.md new file mode 100644 index 00000000000..617a324f4ec --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-changed.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabsAdapter](index.md) / [onSessionsChanged](./on-sessions-changed.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/TabsAdapter.kt#L78) + +Overrides [TabsTray.onSessionsChanged](../../mozilla.components.concept.tabstray/-tabs-tray/on-sessions-changed.md) + +Called after updateSessions() when count number of sessions are updated at the +given position. + diff --git a/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-inserted.md b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-inserted.md new file mode 100644 index 00000000000..9b1d6b22d56 --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-inserted.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabsAdapter](index.md) / [onSessionsInserted](./on-sessions-inserted.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/TabsAdapter.kt#L69) + +Overrides [TabsTray.onSessionsInserted](../../mozilla.components.concept.tabstray/-tabs-tray/on-sessions-inserted.md) + +Called after updateSessions() when count number of sessions are inserted at the +given position. + diff --git a/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-removed.md b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-removed.md new file mode 100644 index 00000000000..8cfca8dfdef --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-sessions-removed.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabsAdapter](index.md) / [onSessionsRemoved](./on-sessions-removed.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/TabsAdapter.kt#L72) + +Overrides [TabsTray.onSessionsRemoved](../../mozilla.components.concept.tabstray/-tabs-tray/on-sessions-removed.md) + +Called after updateSessions() when count number of sessions are removed from +the given position. + diff --git a/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-view-recycled.md b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-view-recycled.md new file mode 100644 index 00000000000..fde9ad44122 --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/on-view-recycled.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabsAdapter](index.md) / [onViewRecycled](./on-view-recycled.md) + +# onViewRecycled + +`fun onViewRecycled(holder: `[`TabViewHolder`](../-tab-view-holder/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/TabsAdapter.kt#L49) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/unsubscribe-holders.md b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/unsubscribe-holders.md new file mode 100644 index 00000000000..d1b53a74937 --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/unsubscribe-holders.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabsAdapter](index.md) / [unsubscribeHolders](./unsubscribe-holders.md) + +# unsubscribeHolders + +`fun unsubscribeHolders(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/TabsAdapter.kt#L53) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/update-sessions.md b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/update-sessions.md new file mode 100644 index 00000000000..3e314ca425c --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/-tabs-adapter/update-sessions.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.browser.tabstray](../index.md) / [TabsAdapter](index.md) / [updateSessions](./update-sessions.md) + +# updateSessions + +`fun updateSessions(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Session`](../../mozilla.components.browser.session/-session/index.md)`>, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/tabstray/src/main/java/mozilla/components/browser/tabstray/TabsAdapter.kt#L64) + +Overrides [TabsTray.updateSessions](../../mozilla.components.concept.tabstray/-tabs-tray/update-sessions.md) + +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/mozilla.components.browser.tabstray/index.md b/docs/api/mozilla.components.browser.tabstray/index.md new file mode 100644 index 00000000000..b302e350757 --- /dev/null +++ b/docs/api/mozilla.components.browser.tabstray/index.md @@ -0,0 +1,20 @@ +[android-components](../index.md) / [mozilla.components.browser.tabstray](./index.md) + +## Package mozilla.components.browser.tabstray + +### Types + +| Name | Summary | +|---|---| +| [BrowserTabsTray](-browser-tabs-tray/index.md) | `class BrowserTabsTray : RecyclerView, `[`TabsTray`](../mozilla.components.concept.tabstray/-tabs-tray/index.md)
A customizable tabs tray for browsers. | +| [TabViewHolder](-tab-view-holder/index.md) | `class TabViewHolder : ViewHolder, `[`Observer`](../mozilla.components.browser.session/-session/-observer/index.md)
A RecyclerView ViewHolder implementation for "tab" items. | +| [TabsAdapter](-tabs-adapter/index.md) | `class TabsAdapter : Adapter<`[`TabViewHolder`](-tab-view-holder/index.md)`>, `[`TabsTray`](../mozilla.components.concept.tabstray/-tabs-tray/index.md)`, `[`Observable`](../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](../mozilla.components.concept.tabstray/-tabs-tray/-observer/index.md)`>`
RecyclerView adapter implementation to display a list/grid of tabs. | + +### Properties + +| Name | Summary | +|---|---| +| [DEFAULT_ITEM_BACKGROUND_COLOR](-d-e-f-a-u-l-t_-i-t-e-m_-b-a-c-k-g-r-o-u-n-d_-c-o-l-o-r.md) | `const val DEFAULT_ITEM_BACKGROUND_COLOR: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [DEFAULT_ITEM_BACKGROUND_SELECTED_COLOR](-d-e-f-a-u-l-t_-i-t-e-m_-b-a-c-k-g-r-o-u-n-d_-s-e-l-e-c-t-e-d_-c-o-l-o-r.md) | `const val DEFAULT_ITEM_BACKGROUND_SELECTED_COLOR: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [DEFAULT_ITEM_TEXT_COLOR](-d-e-f-a-u-l-t_-i-t-e-m_-t-e-x-t_-c-o-l-o-r.md) | `const val DEFAULT_ITEM_TEXT_COLOR: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [DEFAULT_ITEM_TEXT_SELECTED_COLOR](-d-e-f-a-u-l-t_-i-t-e-m_-t-e-x-t_-s-e-l-e-c-t-e-d_-c-o-l-o-r.md) | `const val DEFAULT_ITEM_TEXT_SELECTED_COLOR: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/-init-.md b/docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/-init-.md new file mode 100644 index 00000000000..69a187cd804 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/-init-.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar.behavior](../index.md) / [BrowserToolbarBottomBehavior](index.md) / [<init>](./-init-.md) + +# <init> + +`BrowserToolbarBottomBehavior(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`?, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`?)` + +A [CoordinatorLayout.Behavior](#) implementation to be used when placing [BrowserToolbar](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md) at the bottom of the screen. + +This implementation will: + +* Show/Hide the [BrowserToolbar](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md) automatically when scrolling vertically. +* On showing a [Snackbar](#) position it above the [BrowserToolbar](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md). +* Snap the [BrowserToolbar](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md) to be hidden or visible when the user stops scrolling. diff --git a/docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/index.md b/docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/index.md new file mode 100644 index 00000000000..aaf768b52ba --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/index.md @@ -0,0 +1,28 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar.behavior](../index.md) / [BrowserToolbarBottomBehavior](./index.md) + +# BrowserToolbarBottomBehavior + +`class BrowserToolbarBottomBehavior : Behavior<`[`BrowserToolbar`](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/behavior/BrowserToolbarBottomBehavior.kt#L31) + +A [CoordinatorLayout.Behavior](#) implementation to be used when placing [BrowserToolbar](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md) at the bottom of the screen. + +This implementation will: + +* Show/Hide the [BrowserToolbar](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md) automatically when scrolling vertically. +* On showing a [Snackbar](#) position it above the [BrowserToolbar](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md). +* Snap the [BrowserToolbar](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md) to be hidden or visible when the user stops scrolling. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `BrowserToolbarBottomBehavior(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`?, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`?)`
A [CoordinatorLayout.Behavior](#) implementation to be used when placing [BrowserToolbar](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md) at the bottom of the screen. | + +### Functions + +| Name | Summary | +|---|---| +| [layoutDependsOn](layout-depends-on.md) | `fun layoutDependsOn(parent: CoordinatorLayout, child: `[`BrowserToolbar`](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md)`, dependency: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onNestedPreScroll](on-nested-pre-scroll.md) | `fun onNestedPreScroll(coordinatorLayout: CoordinatorLayout, child: `[`BrowserToolbar`](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md)`, target: `[`View`](https://developer.android.com/reference/android/view/View.html)`, dx: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dy: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, consumed: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`, type: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onStartNestedScroll](on-start-nested-scroll.md) | `fun onStartNestedScroll(coordinatorLayout: CoordinatorLayout, child: `[`BrowserToolbar`](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md)`, directTargetChild: `[`View`](https://developer.android.com/reference/android/view/View.html)`, target: `[`View`](https://developer.android.com/reference/android/view/View.html)`, axes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, type: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onStopNestedScroll](on-stop-nested-scroll.md) | `fun onStopNestedScroll(coordinatorLayout: CoordinatorLayout, child: `[`BrowserToolbar`](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md)`, target: `[`View`](https://developer.android.com/reference/android/view/View.html)`, type: `[`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/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/layout-depends-on.md b/docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/layout-depends-on.md new file mode 100644 index 00000000000..336ee4940e6 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/layout-depends-on.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar.behavior](../index.md) / [BrowserToolbarBottomBehavior](index.md) / [layoutDependsOn](./layout-depends-on.md) + +# layoutDependsOn + +`fun layoutDependsOn(parent: CoordinatorLayout, child: `[`BrowserToolbar`](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md)`, dependency: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/behavior/BrowserToolbarBottomBehavior.kt#L93) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/on-nested-pre-scroll.md b/docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/on-nested-pre-scroll.md new file mode 100644 index 00000000000..1587008fd3d --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/on-nested-pre-scroll.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar.behavior](../index.md) / [BrowserToolbarBottomBehavior](index.md) / [onNestedPreScroll](./on-nested-pre-scroll.md) + +# onNestedPreScroll + +`fun onNestedPreScroll(coordinatorLayout: CoordinatorLayout, child: `[`BrowserToolbar`](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md)`, target: `[`View`](https://developer.android.com/reference/android/view/View.html)`, dx: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, dy: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, consumed: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`, type: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/behavior/BrowserToolbarBottomBehavior.kt#L80) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/on-start-nested-scroll.md b/docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/on-start-nested-scroll.md new file mode 100644 index 00000000000..d7d751aa1f5 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/on-start-nested-scroll.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar.behavior](../index.md) / [BrowserToolbarBottomBehavior](index.md) / [onStartNestedScroll](./on-start-nested-scroll.md) + +# onStartNestedScroll + +`fun onStartNestedScroll(coordinatorLayout: CoordinatorLayout, child: `[`BrowserToolbar`](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md)`, directTargetChild: `[`View`](https://developer.android.com/reference/android/view/View.html)`, target: `[`View`](https://developer.android.com/reference/android/view/View.html)`, axes: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, type: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/behavior/BrowserToolbarBottomBehavior.kt#L47) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/on-stop-nested-scroll.md b/docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/on-stop-nested-scroll.md new file mode 100644 index 00000000000..86f2bab81e3 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar.behavior/-browser-toolbar-bottom-behavior/on-stop-nested-scroll.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar.behavior](../index.md) / [BrowserToolbarBottomBehavior](index.md) / [onStopNestedScroll](./on-stop-nested-scroll.md) + +# onStopNestedScroll + +`fun onStopNestedScroll(coordinatorLayout: CoordinatorLayout, child: `[`BrowserToolbar`](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md)`, target: `[`View`](https://developer.android.com/reference/android/view/View.html)`, type: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/behavior/BrowserToolbarBottomBehavior.kt#L65) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.toolbar.behavior/index.md b/docs/api/mozilla.components.browser.toolbar.behavior/index.md new file mode 100644 index 00000000000..3a603b75d68 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar.behavior/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.browser.toolbar.behavior](./index.md) + +## Package mozilla.components.browser.toolbar.behavior + +### Types + +| Name | Summary | +|---|---| +| [BrowserToolbarBottomBehavior](-browser-toolbar-bottom-behavior/index.md) | `class BrowserToolbarBottomBehavior : Behavior<`[`BrowserToolbar`](../mozilla.components.browser.toolbar/-browser-toolbar/index.md)`>`
A [CoordinatorLayout.Behavior](#) implementation to be used when placing [BrowserToolbar](../mozilla.components.browser.toolbar/-browser-toolbar/index.md) at the bottom of the screen. | diff --git a/docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/-init-.md b/docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/-init-.md new file mode 100644 index 00000000000..7f0b235a686 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/-init-.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar.edit](../index.md) / [EditToolbar](index.md) / [<init>](./-init-.md) + +# <init> + +`EditToolbar(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, toolbar: `[`BrowserToolbar`](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md)`)` + +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/mozilla.components.browser.toolbar.edit/-edit-toolbar/focus.md b/docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/focus.md new file mode 100644 index 00000000000..39a6cc4ffc0 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/focus.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar.edit](../index.md) / [EditToolbar](index.md) / [focus](./focus.md) + +# focus + +`fun focus(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/edit/EditToolbar.kt#L86) + +Focus the URL editing component and show the virtual keyboard if needed. + diff --git a/docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/index.md b/docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/index.md new file mode 100644 index 00000000000..6ab9682ae83 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/index.md @@ -0,0 +1,50 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar.edit](../index.md) / [EditToolbar](./index.md) + +# EditToolbar + +`class EditToolbar : `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/edit/EditToolbar.kt#L35) + +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 + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `EditToolbar(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, toolbar: `[`BrowserToolbar`](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md)`)`
Sub-component of the browser toolbar responsible for allowing the user to edit the URL. | + +### Functions + +| Name | Summary | +|---|---| +| [focus](focus.md) | `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.md) | `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.md) | `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.md) | `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. | + +### Extension Properties + +| Name | Summary | +|---|---| +| [isLTR](../../mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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? | + +### Extension Functions + +| Name | Summary | +|---|---| +| [forEach](../../mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md) | `fun `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`.forEach(action: (`[`View`](https://developer.android.com/reference/android/view/View.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 the given action on each View in this ViewGroup. | +| [hideKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.hideKeyboard(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Hides the soft input window. | +| [isGone](../../mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [isVisible](../../mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [setPadding](../../mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.setPadding(padding: `[`Padding`](../../mozilla.components.support.base.android/-padding/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Set a padding using [Padding](../../mozilla.components.support.base.android/-padding/index.md) object. | +| [showKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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/mozilla.components.browser.toolbar.edit/-edit-toolbar/on-layout.md b/docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/on-layout.md new file mode 100644 index 00000000000..c971b8622a5 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/on-layout.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar.edit](../index.md) / [EditToolbar](index.md) / [onLayout](./on-layout.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/edit/EditToolbar.kt#L107) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/on-measure.md b/docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/on-measure.md new file mode 100644 index 00000000000..9bf9247ae6c --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/on-measure.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar.edit](../index.md) / [EditToolbar](index.md) / [onMeasure](./on-measure.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/edit/EditToolbar.kt#L91) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/update-url.md b/docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/update-url.md new file mode 100644 index 00000000000..861da933bc5 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar.edit/-edit-toolbar/update-url.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar.edit](../index.md) / [EditToolbar](index.md) / [updateUrl](./update-url.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/edit/EditToolbar.kt#L79) + +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/mozilla.components.browser.toolbar.edit/index.md b/docs/api/mozilla.components.browser.toolbar.edit/index.md new file mode 100644 index 00000000000..a5ca49dc271 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar.edit/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.browser.toolbar.edit](./index.md) + +## Package mozilla.components.browser.toolbar.edit + +### Types + +| Name | Summary | +|---|---| +| [EditToolbar](-edit-toolbar/index.md) | `class EditToolbar : `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)
Sub-component of the browser toolbar responsible for allowing the user to edit the URL. | diff --git a/docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/-init-.md b/docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/-init-.md new file mode 100644 index 00000000000..09f03431759 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [AsyncAutocompleteDelegate](index.md) / [<init>](./-init-.md) + +# <init> + +`AsyncAutocompleteDelegate(urlView: `[`AutocompleteView`](../../mozilla.components.ui.autocomplete/-autocomplete-view/index.md)`, parentScope: CoroutineScope, coroutineContext: `[`CoroutineContext`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html)`, logger: `[`Logger`](../../mozilla.components.support.base.log.logger/-logger/index.md)` = Logger("AsyncAutocompleteDelegate"))` + +An autocomplete delegate which is aware of its parent scope (to check for cancellations). +Responsible for processing autocompletion results and discarding stale results when [urlView](-init-.md#mozilla.components.browser.toolbar.AsyncAutocompleteDelegate$(mozilla.components.ui.autocomplete.AutocompleteView, kotlinx.coroutines.CoroutineScope, kotlin.coroutines.CoroutineContext, mozilla.components.support.base.log.logger.Logger)/urlView) moved on. + diff --git a/docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/apply-autocomplete-result.md b/docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/apply-autocomplete-result.md new file mode 100644 index 00000000000..ef1fa869b8d --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/apply-autocomplete-result.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [AsyncAutocompleteDelegate](index.md) / [applyAutocompleteResult](./apply-autocomplete-result.md) + +# applyAutocompleteResult + +`fun applyAutocompleteResult(result: `[`AutocompleteResult`](../../mozilla.components.concept.toolbar/-autocomplete-result/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L567) + +Overrides [AutocompleteDelegate.applyAutocompleteResult](../../mozilla.components.concept.toolbar/-autocomplete-delegate/apply-autocomplete-result.md) + +### Parameters + +`result` - Apply result of autocompletion. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/coroutine-context.md b/docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/coroutine-context.md new file mode 100644 index 00000000000..acbe92b9d61 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/coroutine-context.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [AsyncAutocompleteDelegate](index.md) / [coroutineContext](./coroutine-context.md) + +# coroutineContext + +`val coroutineContext: `[`CoroutineContext`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L564) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/index.md b/docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/index.md new file mode 100644 index 00000000000..8596e9f3c6e --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/index.md @@ -0,0 +1,27 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [AsyncAutocompleteDelegate](./index.md) + +# AsyncAutocompleteDelegate + +`class AsyncAutocompleteDelegate : `[`AutocompleteDelegate`](../../mozilla.components.concept.toolbar/-autocomplete-delegate/index.md)`, CoroutineScope` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L561) + +An autocomplete delegate which is aware of its parent scope (to check for cancellations). +Responsible for processing autocompletion results and discarding stale results when [urlView](#) moved on. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AsyncAutocompleteDelegate(urlView: `[`AutocompleteView`](../../mozilla.components.ui.autocomplete/-autocomplete-view/index.md)`, parentScope: CoroutineScope, coroutineContext: `[`CoroutineContext`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html)`, logger: `[`Logger`](../../mozilla.components.support.base.log.logger/-logger/index.md)` = Logger("AsyncAutocompleteDelegate"))`
An autocomplete delegate which is aware of its parent scope (to check for cancellations). Responsible for processing autocompletion results and discarding stale results when [urlView](-init-.md#mozilla.components.browser.toolbar.AsyncAutocompleteDelegate$(mozilla.components.ui.autocomplete.AutocompleteView, kotlinx.coroutines.CoroutineScope, kotlin.coroutines.CoroutineContext, mozilla.components.support.base.log.logger.Logger)/urlView) moved on. | + +### Properties + +| Name | Summary | +|---|---| +| [coroutineContext](coroutine-context.md) | `val coroutineContext: `[`CoroutineContext`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [applyAutocompleteResult](apply-autocomplete-result.md) | `fun applyAutocompleteResult(result: `[`AutocompleteResult`](../../mozilla.components.concept.toolbar/-autocomplete-result/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [noAutocompleteResult](no-autocomplete-result.md) | `fun noAutocompleteResult(input: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Autocompletion was invoked and no match was returned. | diff --git a/docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/no-autocomplete-result.md b/docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/no-autocomplete-result.md new file mode 100644 index 00000000000..0c545e99f6a --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-async-autocomplete-delegate/no-autocomplete-result.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [AsyncAutocompleteDelegate](index.md) / [noAutocompleteResult](./no-autocomplete-result.md) + +# noAutocompleteResult + +`fun noAutocompleteResult(input: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L591) + +Overrides [AutocompleteDelegate.noAutocompleteResult](../../mozilla.components.concept.toolbar/-autocomplete-delegate/no-autocomplete-result.md) + +Autocompletion was invoked and no match was returned. + diff --git a/docs/api/mozilla.components.browser.toolbar/-async-filter-listener/-init-.md b/docs/api/mozilla.components.browser.toolbar/-async-filter-listener/-init-.md new file mode 100644 index 00000000000..dbe4676018d --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-async-filter-listener/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [AsyncFilterListener](index.md) / [<init>](./-init-.md) + +# <init> + +`AsyncFilterListener(urlView: `[`AutocompleteView`](../../mozilla.components.ui.autocomplete/-autocomplete-view/index.md)`, coroutineContext: `[`CoroutineContext`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html)`, filter: suspend (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`AutocompleteDelegate`](../../mozilla.components.concept.toolbar/-autocomplete-delegate/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, uiContext: `[`CoroutineContext`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html)` = Dispatchers.Main)` + +Wraps [filter](-init-.md#mozilla.components.browser.toolbar.AsyncFilterListener$(mozilla.components.ui.autocomplete.AutocompleteView, kotlin.coroutines.CoroutineContext, kotlin.SuspendFunction2((kotlin.String, mozilla.components.concept.toolbar.AutocompleteDelegate, kotlin.Unit)), kotlin.coroutines.CoroutineContext)/filter) execution in a coroutine context, cancelling prior executions on every invocation. +[coroutineContext](-init-.md#mozilla.components.browser.toolbar.AsyncFilterListener$(mozilla.components.ui.autocomplete.AutocompleteView, kotlin.coroutines.CoroutineContext, kotlin.SuspendFunction2((kotlin.String, mozilla.components.concept.toolbar.AutocompleteDelegate, kotlin.Unit)), kotlin.coroutines.CoroutineContext)/coroutineContext) must be of type that doesn't propagate cancellation of its children upwards. + diff --git a/docs/api/mozilla.components.browser.toolbar/-async-filter-listener/coroutine-context.md b/docs/api/mozilla.components.browser.toolbar/-async-filter-listener/coroutine-context.md new file mode 100644 index 00000000000..7cf03f71390 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-async-filter-listener/coroutine-context.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [AsyncFilterListener](index.md) / [coroutineContext](./coroutine-context.md) + +# coroutineContext + +`val coroutineContext: `[`CoroutineContext`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L542) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.toolbar/-async-filter-listener/index.md b/docs/api/mozilla.components.browser.toolbar/-async-filter-listener/index.md new file mode 100644 index 00000000000..f0735bfccd2 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-async-filter-listener/index.md @@ -0,0 +1,26 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [AsyncFilterListener](./index.md) + +# AsyncFilterListener + +`class AsyncFilterListener : `[`OnFilterListener`](../../mozilla.components.ui.autocomplete/-on-filter-listener.md)`, CoroutineScope` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L540) + +Wraps [filter](#) execution in a coroutine context, cancelling prior executions on every invocation. +[coroutineContext](coroutine-context.md) must be of type that doesn't propagate cancellation of its children upwards. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AsyncFilterListener(urlView: `[`AutocompleteView`](../../mozilla.components.ui.autocomplete/-autocomplete-view/index.md)`, coroutineContext: `[`CoroutineContext`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html)`, filter: suspend (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`AutocompleteDelegate`](../../mozilla.components.concept.toolbar/-autocomplete-delegate/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, uiContext: `[`CoroutineContext`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html)` = Dispatchers.Main)`
Wraps [filter](-init-.md#mozilla.components.browser.toolbar.AsyncFilterListener$(mozilla.components.ui.autocomplete.AutocompleteView, kotlin.coroutines.CoroutineContext, kotlin.SuspendFunction2((kotlin.String, mozilla.components.concept.toolbar.AutocompleteDelegate, kotlin.Unit)), kotlin.coroutines.CoroutineContext)/filter) execution in a coroutine context, cancelling prior executions on every invocation. [coroutineContext](-init-.md#mozilla.components.browser.toolbar.AsyncFilterListener$(mozilla.components.ui.autocomplete.AutocompleteView, kotlin.coroutines.CoroutineContext, kotlin.SuspendFunction2((kotlin.String, mozilla.components.concept.toolbar.AutocompleteDelegate, kotlin.Unit)), kotlin.coroutines.CoroutineContext)/coroutineContext) must be of type that doesn't propagate cancellation of its children upwards. | + +### Properties + +| Name | Summary | +|---|---| +| [coroutineContext](coroutine-context.md) | `val coroutineContext: `[`CoroutineContext`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `fun invoke(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) | diff --git a/docs/api/mozilla.components.browser.toolbar/-async-filter-listener/invoke.md b/docs/api/mozilla.components.browser.toolbar/-async-filter-listener/invoke.md new file mode 100644 index 00000000000..b30813dafae --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-async-filter-listener/invoke.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [AsyncFilterListener](index.md) / [invoke](./invoke.md) + +# invoke + +`fun invoke(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L546) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-button/-init-.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-button/-init-.md new file mode 100644 index 00000000000..37fcef3b3f1 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-button/-init-.md @@ -0,0 +1,21 @@ +[android-components](../../../index.md) / [mozilla.components.browser.toolbar](../../index.md) / [BrowserToolbar](../index.md) / [Button](index.md) / [<init>](./-init-.md) + +# <init> + +`Button(imageDrawable: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.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)` = 0, padding: `[`Padding`](../../../mozilla.components.support.base.android/-padding/index.md)` = DEFAULT_PADDING, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +An action button to be added to the toolbar. + +### Parameters + +`imageDrawable` - 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. + +`padding` - a custom [Padding](../../../mozilla.components.support.base.android/-padding/index.md) for this Button. + +`listener` - Callback that will be invoked whenever the button is pressed \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-button/index.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-button/index.md new file mode 100644 index 00000000000..e63e187f09b --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-button/index.md @@ -0,0 +1,54 @@ +[android-components](../../../index.md) / [mozilla.components.browser.toolbar](../../index.md) / [BrowserToolbar](../index.md) / [Button](./index.md) + +# Button + +`class Button : `[`ActionButton`](../../../mozilla.components.concept.toolbar/-toolbar/-action-button/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L439) + +An action button to be added to the toolbar. + +### Parameters + +`imageDrawable` - 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. + +`padding` - a custom [Padding](../../../mozilla.components.support.base.android/-padding/index.md) for this Button. + +`listener` - Callback that will be invoked whenever the button is pressed + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Button(imageDrawable: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.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)` = 0, padding: `[`Padding`](../../../mozilla.components.support.base.android/-padding/index.md)` = DEFAULT_PADDING, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
An action button to be added to the toolbar. | + +### Properties + +| Name | Summary | +|---|---| +| [padding](padding.md) | `val padding: `[`Padding`](../../../mozilla.components.support.base.android/-padding/index.md)
a custom [Padding](../../../mozilla.components.support.base.android/-padding/index.md) for this Button. | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [contentDescription](../../../mozilla.components.concept.toolbar/-toolbar/-action-button/content-description.md) | `val contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The content description to use. | +| [imageDrawable](../../../mozilla.components.concept.toolbar/-toolbar/-action-button/image-drawable.md) | `val imageDrawable: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`?`
The drawable to be shown. | +| [visible](../../../mozilla.components.concept.toolbar/-toolbar/-action-button/visible.md) | `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. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [bind](../../../mozilla.components.concept.toolbar/-toolbar/-action-button/bind.md) | `open fun bind(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [createView](../../../mozilla.components.concept.toolbar/-toolbar/-action-button/create-view.md) | `open fun createView(parent: `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`): `[`View`](https://developer.android.com/reference/android/view/View.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [TwoStateButton](../-two-state-button/index.md) | `class TwoStateButton : `[`Button`](./index.md)
An action that either shows an active button or an inactive button based on the provided isEnabled lambda. | diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-button/padding.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-button/padding.md new file mode 100644 index 00000000000..7e5bd66b77d --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-button/padding.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.toolbar](../../index.md) / [BrowserToolbar](../index.md) / [Button](index.md) / [padding](./padding.md) + +# padding + +`val padding: `[`Padding`](../../../mozilla.components.support.base.android/-padding/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L444) + +a custom [Padding](../../../mozilla.components.support.base.android/-padding/index.md) for this Button. + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-init-.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-init-.md new file mode 100644 index 00000000000..997c1148f1d --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-init-.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [<init>](./-init-.md) + +# <init> + +`BrowserToolbar(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = 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/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/-init-.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/-init-.md new file mode 100644 index 00000000000..1e24b9a6082 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/-init-.md @@ -0,0 +1,28 @@ +[android-components](../../../index.md) / [mozilla.components.browser.toolbar](../../index.md) / [BrowserToolbar](../index.md) / [ToggleButton](index.md) / [<init>](./-init-.md) + +# <init> + +`ToggleButton(image: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`, imageSelected: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.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)` = 0, padding: `[`Padding`](../../../mozilla.components.support.base.android/-padding/index.md)` = DEFAULT_PADDING, 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 + +`image` - The drawable to be shown if the button is in unselected state. + +`imageSelected` - 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. + +`padding` - a custom [Padding](../../../mozilla.components.support.base.android/-padding/index.md) for this Button. + +`listener` - Callback that will be invoked whenever the checked state changes. \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/index.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/index.md new file mode 100644 index 00000000000..e8c55f51c3a --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/index.md @@ -0,0 +1,56 @@ +[android-components](../../../index.md) / [mozilla.components.browser.toolbar](../../index.md) / [BrowserToolbar](../index.md) / [ToggleButton](./index.md) + +# ToggleButton + +`class ToggleButton : `[`ActionToggleButton`](../../../mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L462) + +An action button with two states, selected and unselected. When the button is pressed, the +state changes automatically. + +### Parameters + +`image` - The drawable to be shown if the button is in unselected state. + +`imageSelected` - 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. + +`padding` - a custom [Padding](../../../mozilla.components.support.base.android/-padding/index.md) for this Button. + +`listener` - Callback that will be invoked whenever the checked state changes. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ToggleButton(image: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`, imageSelected: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.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)` = 0, padding: `[`Padding`](../../../mozilla.components.support.base.android/-padding/index.md)` = DEFAULT_PADDING, 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 + +| Name | Summary | +|---|---| +| [padding](padding.md) | `val padding: `[`Padding`](../../../mozilla.components.support.base.android/-padding/index.md)
a custom [Padding](../../../mozilla.components.support.base.android/-padding/index.md) for this Button. | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [visible](../../../mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/visible.md) | `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. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [bind](../../../mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/bind.md) | `open fun bind(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [createView](../../../mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/create-view.md) | `open fun createView(parent: `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`): `[`View`](https://developer.android.com/reference/android/view/View.html) | +| [isSelected](../../../mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/is-selected.md) | `fun isSelected(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns the current selected state of the action. | +| [setSelected](../../../mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/set-selected.md) | `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](../../../mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/toggle.md) | `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/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/padding.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/padding.md new file mode 100644 index 00000000000..d8d9fe425c8 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/padding.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.toolbar](../../index.md) / [BrowserToolbar](../index.md) / [ToggleButton](index.md) / [padding](./padding.md) + +# padding + +`val padding: `[`Padding`](../../../mozilla.components.support.base.android/-padding/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L470) + +a custom [Padding](../../../mozilla.components.support.base.android/-padding/index.md) for this Button. + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-two-state-button/-init-.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-two-state-button/-init-.md new file mode 100644 index 00000000000..12e4c35df2d --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-two-state-button/-init-.md @@ -0,0 +1,24 @@ +[android-components](../../../index.md) / [mozilla.components.browser.toolbar](../../index.md) / [BrowserToolbar](../index.md) / [TwoStateButton](index.md) / [<init>](./-init-.md) + +# <init> + +`TwoStateButton(enabledImage: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`, enabledContentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, disabledImage: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`, disabledContentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, isEnabled: () -> `[`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)` = 0, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +An action that either shows an active button or an inactive button based on the provided +isEnabled lambda. + +### Parameters + +`enabledImage` - The drawable to be show if the button is in the enabled stated. + +`enabledContentDescription` - The content description to use if the button is in the enabled state. + +`disabledImage` - The drawable to be show if the button is in the disabled stated. + +`disabledContentDescription` - The content description to use if the button is in the enabled state. + +`isEnabled` - Lambda that returns true of false to indicate whether this button should be enabled/disabled. + +`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/mozilla.components.browser.toolbar/-browser-toolbar/-two-state-button/bind.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-two-state-button/bind.md new file mode 100644 index 00000000000..8afa99b3b2e --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-two-state-button/bind.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.browser.toolbar](../../index.md) / [BrowserToolbar](../index.md) / [TwoStateButton](index.md) / [bind](./bind.md) + +# bind + +`open fun bind(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L513) + +Overrides [ActionButton.bind](../../../mozilla.components.concept.toolbar/-toolbar/-action-button/bind.md) + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-two-state-button/enabled.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-two-state-button/enabled.md new file mode 100644 index 00000000000..4fc6e3d7eda --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-two-state-button/enabled.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.browser.toolbar](../../index.md) / [BrowserToolbar](../index.md) / [TwoStateButton](index.md) / [enabled](./enabled.md) + +# enabled + +`var enabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L510) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-two-state-button/index.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-two-state-button/index.md new file mode 100644 index 00000000000..be5bbe4d6ae --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/-two-state-button/index.md @@ -0,0 +1,48 @@ +[android-components](../../../index.md) / [mozilla.components.browser.toolbar](../../index.md) / [BrowserToolbar](../index.md) / [TwoStateButton](./index.md) + +# TwoStateButton + +`class TwoStateButton : `[`Button`](../-button/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L496) + +An action that either shows an active button or an inactive button based on the provided +isEnabled lambda. + +### Parameters + +`enabledImage` - The drawable to be show if the button is in the enabled stated. + +`enabledContentDescription` - The content description to use if the button is in the enabled state. + +`disabledImage` - The drawable to be show if the button is in the disabled stated. + +`disabledContentDescription` - The content description to use if the button is in the enabled state. + +`isEnabled` - Lambda that returns true of false to indicate whether this button should be enabled/disabled. + +`background` - A custom (stateful) background drawable resource to be used. + +`listener` - Callback that will be invoked whenever the checked state changes. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TwoStateButton(enabledImage: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`, enabledContentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, disabledImage: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`, disabledContentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, isEnabled: () -> `[`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)` = 0, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
An action that either shows an active button or an inactive button based on the provided isEnabled lambda. | + +### Properties + +| Name | Summary | +|---|---| +| [enabled](enabled.md) | `var enabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [padding](../-button/padding.md) | `val padding: `[`Padding`](../../../mozilla.components.support.base.android/-padding/index.md)
a custom [Padding](../../../mozilla.components.support.base.android/-padding/index.md) for this Button. | + +### Functions + +| Name | Summary | +|---|---| +| [bind](bind.md) | `open fun bind(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/add-browser-action.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/add-browser-action.md new file mode 100644 index 00000000000..23fd918896b --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/add-browser-action.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [addBrowserAction](./add-browser-action.md) + +# addBrowserAction + +`fun addBrowserAction(action: `[`Action`](../../mozilla.components.concept.toolbar/-toolbar/-action/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L351) + +Overrides [Toolbar.addBrowserAction](../../mozilla.components.concept.toolbar/-toolbar/add-browser-action.md) + +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/mozilla.components.browser.toolbar/-browser-toolbar/add-navigation-action.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/add-navigation-action.md new file mode 100644 index 00000000000..6e9ce810848 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/add-navigation-action.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [addNavigationAction](./add-navigation-action.md) + +# addNavigationAction + +`fun addNavigationAction(action: `[`Action`](../../mozilla.components.concept.toolbar/-toolbar/-action/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L369) + +Overrides [Toolbar.addNavigationAction](../../mozilla.components.concept.toolbar/-toolbar/add-navigation-action.md) + +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/mozilla.components.browser.toolbar/-browser-toolbar/add-page-action.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/add-page-action.md new file mode 100644 index 00000000000..890a6c32717 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/add-page-action.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [addPageAction](./add-page-action.md) + +# addPageAction + +`fun addPageAction(action: `[`Action`](../../mozilla.components.concept.toolbar/-toolbar/-action/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L361) + +Overrides [Toolbar.addPageAction](../../mozilla.components.concept.toolbar/-toolbar/add-page-action.md) + +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/mozilla.components.browser.toolbar/-browser-toolbar/browser-action-margin.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/browser-action-margin.md new file mode 100644 index 00000000000..93ed392c424 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/browser-action-margin.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [browserActionMargin](./browser-action-margin.md) + +# browserActionMargin + +`var browserActionMargin: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L115) + +Gets/Sets the margin to be used between browser actions. + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/display-mode.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/display-mode.md new file mode 100644 index 00000000000..3c0a00712c6 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/display-mode.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [displayMode](./display-mode.md) + +# displayMode + +`fun displayMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L388) + +Overrides [Toolbar.displayMode](../../mozilla.components.concept.toolbar/-toolbar/display-mode.md) + +Switches to URL displaying mode. + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/display-progress.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/display-progress.md new file mode 100644 index 00000000000..ec50641dc35 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/display-progress.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [displayProgress](./display-progress.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L321) + +Overrides [Toolbar.displayProgress](../../mozilla.components.concept.toolbar/-toolbar/display-progress.md) + +Displays the given loading progress. Expects values in the range [0,100](#). + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/display-site-security-icon.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/display-site-security-icon.md new file mode 100644 index 00000000000..5630f07f404 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/display-site-security-icon.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [displaySiteSecurityIcon](./display-site-security-icon.md) + +# displaySiteSecurityIcon + +`var displaySiteSecurityIcon: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L87) + +Set/Get whether a site security icon (usually a lock or globe icon) should be visible next to the URL. + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/edit-mode.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/edit-mode.md new file mode 100644 index 00000000000..f99f5ffc976 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/edit-mode.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [editMode](./edit-mode.md) + +# editMode + +`fun editMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L376) + +Overrides [Toolbar.editMode](../../mozilla.components.concept.toolbar/-toolbar/edit-mode.md) + +Switches to URL editing mode. + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/hint-color.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/hint-color.md new file mode 100644 index 00000000000..731e2cdd7f4 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/hint-color.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [hintColor](./hint-color.md) + +# hintColor + +`var hintColor: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L148) + +Sets the colour of the text to be displayed when the URL of the toolbar is empty. + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/hint.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/hint.md new file mode 100644 index 00000000000..a5ea97d68ff --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/hint.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [hint](./hint.md) + +# hint + +`var hint: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L138) + +Sets the text to be displayed when the URL of the toolbar is empty. + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/index.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/index.md new file mode 100644 index 00000000000..f504612846a --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/index.md @@ -0,0 +1,104 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](./index.md) + +# BrowserToolbar + +`class BrowserToolbar : `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`, `[`Toolbar`](../../mozilla.components.concept.toolbar/-toolbar/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L63) + +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 + +| Name | Summary | +|---|---| +| [Button](-button/index.md) | `class Button : `[`ActionButton`](../../mozilla.components.concept.toolbar/-toolbar/-action-button/index.md)
An action button to be added to the toolbar. | +| [ToggleButton](-toggle-button/index.md) | `class ToggleButton : `[`ActionToggleButton`](../../mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/index.md)
An action button with two states, selected and unselected. When the button is pressed, the state changes automatically. | +| [TwoStateButton](-two-state-button/index.md) | `class TwoStateButton : `[`Button`](-button/index.md)
An action that either shows an active button or an inactive button based on the provided isEnabled lambda. | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `BrowserToolbar(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)`
A customizable toolbar for browsers. | + +### Properties + +| Name | Summary | +|---|---| +| [browserActionMargin](browser-action-margin.md) | `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.md) | `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 visible next to the URL. | +| [hint](hint.md) | `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. | +| [hintColor](hint-color.md) | `var hintColor: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Sets the colour of the text to be displayed when the URL of the toolbar is empty. | +| [menuViewColor](menu-view-color.md) | `var menuViewColor: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [onUrlClicked](on-url-clicked.md) | `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. | +| [siteSecure](site-secure.md) | `var siteSecure: `[`SiteSecurity`](../../mozilla.components.concept.toolbar/-toolbar/-site-security/index.md)
Sets/Gets the site security to be displayed on the toolbar. | +| [siteSecurityColor](site-security-color.md) | `var siteSecurityColor: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`>`
Set/Get the site security icon colours (usually a lock or globe icon). It uses a pair of integers which represent the insecure and secure colours respectively. | +| [textColor](text-color.md) | `var textColor: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Sets the colour of the text for the URL/search term displayed in the toolbar. | +| [textSize](text-size.md) | `var textSize: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)
Sets the size of the text for the URL/search term displayed in the toolbar. | +| [typeface](typeface.md) | `var typeface: `[`Typeface`](https://developer.android.com/reference/android/graphics/Typeface.html)
Sets the typeface of the text for the URL/search term displayed in the toolbar. | +| [url](url.md) | `var url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Sets/Gets the URL to be displayed on the toolbar. | +| [urlBoxMargin](url-box-margin.md) | `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.md) | `var urlBoxView: `[`View`](https://developer.android.com/reference/android/view/View.html)`?`
Gets/Sets a custom view that will be drawn as behind the URL and page actions in display mode. | + +### Functions + +| Name | Summary | +|---|---| +| [addBrowserAction](add-browser-action.md) | `fun addBrowserAction(action: `[`Action`](../../mozilla.components.concept.toolbar/-toolbar/-action/index.md)`): `[`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.md) | `fun addNavigationAction(action: `[`Action`](../../mozilla.components.concept.toolbar/-toolbar/-action/index.md)`): `[`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.md) | `fun addPageAction(action: `[`Action`](../../mozilla.components.concept.toolbar/-toolbar/-action/index.md)`): `[`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.md) | `fun displayMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Switches to URL displaying mode. | +| [displayProgress](display-progress.md) | `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](#). | +| [editMode](edit-mode.md) | `fun editMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Switches to URL editing mode. | +| [invalidateActions](invalidate-actions.md) | `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.md) | `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. | +| [onLayout](on-layout.md) | `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.md) | `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) | +| [setAutocompleteListener](set-autocomplete-listener.md) | `fun setAutocompleteListener(filter: suspend (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`AutocompleteDelegate`](../../mozilla.components.concept.toolbar/-autocomplete-delegate/index.md)`) -> `[`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 users changes text in the toolbar. | +| [setMenuBuilder](set-menu-builder.md) | `fun setMenuBuilder(menuBuilder: `[`BrowserMenuBuilder`](../../mozilla.components.browser.menu/-browser-menu-builder/index.md)`): `[`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.md) | `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. | +| [setOnEditListener](set-on-edit-listener.md) | `fun setOnEditListener(listener: `[`OnEditListener`](../../mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Registers the given listener to be invoked when the user edits the URL. | +| [setOnUrlCommitListener](set-on-url-commit-listener.md) | `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.md) | `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. | +| [setUrlTextPadding](set-url-text-padding.md) | `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). | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [asView](../../mozilla.components.concept.toolbar/-toolbar/as-view.md) | `open fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html)
Casts this toolbar to an Android View object. | + +### Extension Properties + +| Name | Summary | +|---|---| +| [isLTR](../../mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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? | + +### Extension Functions + +| Name | Summary | +|---|---| +| [forEach](../../mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md) | `fun `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`.forEach(action: (`[`View`](https://developer.android.com/reference/android/view/View.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 the given action on each View in this ViewGroup. | +| [hideKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.hideKeyboard(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Hides the soft input window. | +| [isGone](../../mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [isVisible](../../mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [setPadding](../../mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.setPadding(padding: `[`Padding`](../../mozilla.components.support.base.android/-padding/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Set a padding using [Padding](../../mozilla.components.support.base.android/-padding/index.md) object. | +| [showKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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/mozilla.components.browser.toolbar/-browser-toolbar/invalidate-actions.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/invalidate-actions.md new file mode 100644 index 00000000000..af1bffc725d --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/invalidate-actions.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [invalidateActions](./invalidate-actions.md) + +# invalidateActions + +`fun invalidateActions(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L337) + +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/mozilla.components.browser.toolbar/-browser-toolbar/menu-view-color.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/menu-view-color.md new file mode 100644 index 00000000000..64935c4828d --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/menu-view-color.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [menuViewColor](./menu-view-color.md) + +# menuViewColor + +`var menuViewColor: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L108) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/on-back-pressed.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/on-back-pressed.md new file mode 100644 index 00000000000..d00203a767f --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/on-back-pressed.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [onBackPressed](./on-back-pressed.md) + +# onBackPressed + +`fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L309) + +Overrides [Toolbar.onBackPressed](../../mozilla.components.concept.toolbar/-toolbar/on-back-pressed.md) + +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/mozilla.components.browser.toolbar/-browser-toolbar/on-layout.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/on-layout.md new file mode 100644 index 00000000000..6c1ab81ad5f --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/on-layout.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [onLayout](./on-layout.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L276) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/on-measure.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/on-measure.md new file mode 100644 index 00000000000..a4aef66e7e0 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/on-measure.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [onMeasure](./on-measure.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L287) \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/on-url-clicked.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/on-url-clicked.md new file mode 100644 index 00000000000..0cce07ab014 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/on-url-clicked.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [onUrlClicked](./on-url-clicked.md) + +# onUrlClicked + +`var onUrlClicked: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L131) + +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/mozilla.components.browser.toolbar/-browser-toolbar/set-autocomplete-listener.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-autocomplete-listener.md new file mode 100644 index 00000000000..78da3cff93b --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-autocomplete-listener.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [setAutocompleteListener](./set-autocomplete-listener.md) + +# setAutocompleteListener + +`fun setAutocompleteListener(filter: suspend (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`AutocompleteDelegate`](../../mozilla.components.concept.toolbar/-autocomplete-delegate/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L198) + +Overrides [Toolbar.setAutocompleteListener](../../mozilla.components.concept.toolbar/-toolbar/set-autocomplete-listener.md) + +Registers the given function to be invoked when users changes text in the toolbar. + +### Parameters + +`filter` - A function which will perform autocompletion and send results to [AutocompleteDelegate](../../mozilla.components.concept.toolbar/-autocomplete-delegate/index.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-menu-builder.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-menu-builder.md new file mode 100644 index 00000000000..92f3d92d4fb --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-menu-builder.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [setMenuBuilder](./set-menu-builder.md) + +# setMenuBuilder + +`fun setMenuBuilder(menuBuilder: `[`BrowserMenuBuilder`](../../mozilla.components.browser.menu/-browser-menu-builder/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L396) + +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/mozilla.components.browser.toolbar/-browser-toolbar/set-on-edit-focus-change-listener.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-on-edit-focus-change-listener.md new file mode 100644 index 00000000000..527e108ea0b --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-on-edit-focus-change-listener.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [setOnEditFocusChangeListener](./set-on-edit-focus-change-listener.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L188) + +Sets a listener to be invoked when focus of the URL input view (in edit mode) changed. + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-on-edit-listener.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-on-edit-listener.md new file mode 100644 index 00000000000..984fd60c04f --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-on-edit-listener.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [setOnEditListener](./set-on-edit-listener.md) + +# setOnEditListener + +`fun setOnEditListener(listener: `[`OnEditListener`](../../mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L194) + +Overrides [Toolbar.setOnEditListener](../../mozilla.components.concept.toolbar/-toolbar/set-on-edit-listener.md) + +Registers the given listener to be invoked when the user edits the URL. + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-on-url-commit-listener.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-on-url-commit-listener.md new file mode 100644 index 00000000000..14c80b845df --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-on-url-commit-listener.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [setOnUrlCommitListener](./set-on-url-commit-listener.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L325) + +Overrides [Toolbar.setOnUrlCommitListener](../../mozilla.components.concept.toolbar/-toolbar/set-on-url-commit-listener.md) + +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/mozilla.components.browser.toolbar/-browser-toolbar/set-search-terms.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-search-terms.md new file mode 100644 index 00000000000..93a35fde612 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-search-terms.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [setSearchTerms](./set-search-terms.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L317) + +Overrides [Toolbar.setSearchTerms](../../mozilla.components.concept.toolbar/-toolbar/set-search-terms.md) + +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/mozilla.components.browser.toolbar/-browser-toolbar/set-url-text-padding.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-url-text-padding.md new file mode 100644 index 00000000000..9f40a16b311 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/set-url-text-padding.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [setUrlTextPadding](./set-url-text-padding.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L211) + +Sets the padding to be applied to the URL text (in display mode). + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/site-secure.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/site-secure.md new file mode 100644 index 00000000000..d99fc92fe0c --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/site-secure.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [siteSecure](./site-secure.md) + +# siteSecure + +`var siteSecure: `[`SiteSecurity`](../../mozilla.components.concept.toolbar/-toolbar/-site-security/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L232) + +Overrides [Toolbar.siteSecure](../../mozilla.components.concept.toolbar/-toolbar/site-secure.md) + +Sets/Gets the site security to be displayed on the toolbar. + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/site-security-color.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/site-security-color.md new file mode 100644 index 00000000000..b2f82b93945 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/site-security-color.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [siteSecurityColor](./site-security-color.md) + +# siteSecurityColor + +`var siteSecurityColor: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L97) + +Set/Get the site security icon colours (usually a lock or globe icon). It uses a pair of integers +which represent the insecure and secure colours respectively. + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/text-color.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/text-color.md new file mode 100644 index 00000000000..36eb3d6deb3 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/text-color.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [textColor](./text-color.md) + +# textColor + +`var textColor: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L158) + +Sets the colour of the text for the URL/search term displayed in the toolbar. + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/text-size.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/text-size.md new file mode 100644 index 00000000000..49be23e9205 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/text-size.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [textSize](./text-size.md) + +# textSize + +`var textSize: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L168) + +Sets the size of the text for the URL/search term displayed in the toolbar. + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/typeface.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/typeface.md new file mode 100644 index 00000000000..7f331b543fd --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/typeface.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [typeface](./typeface.md) + +# typeface + +`var typeface: `[`Typeface`](https://developer.android.com/reference/android/graphics/Typeface.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L178) + +Sets the typeface of the text for the URL/search term displayed in the toolbar. + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/url-box-margin.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/url-box-margin.md new file mode 100644 index 00000000000..b74d7e1ac12 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/url-box-margin.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [urlBoxMargin](./url-box-margin.md) + +# urlBoxMargin + +`var urlBoxMargin: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L122) + +Gets/Sets horizontal margin of the URL box (surrounding URL and page actions) in display mode. + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/url-box-view.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/url-box-view.md new file mode 100644 index 00000000000..a681d96637e --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/url-box-view.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [urlBoxView](./url-box-view.md) + +# urlBoxView + +`var urlBoxView: `[`View`](https://developer.android.com/reference/android/view/View.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L104) + +Gets/Sets a custom view that will be drawn as behind the URL and page actions in display mode. + diff --git a/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/url.md b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/url.md new file mode 100644 index 00000000000..d8d2fdec064 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/-browser-toolbar/url.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.browser.toolbar](../index.md) / [BrowserToolbar](index.md) / [url](./url.md) + +# url + +`var url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt#L222) + +Overrides [Toolbar.url](../../mozilla.components.concept.toolbar/-toolbar/url.md) + +Sets/Gets the URL to be displayed on the toolbar. + diff --git a/docs/api/mozilla.components.browser.toolbar/index.md b/docs/api/mozilla.components.browser.toolbar/index.md new file mode 100644 index 00000000000..39f1b0cc0e6 --- /dev/null +++ b/docs/api/mozilla.components.browser.toolbar/index.md @@ -0,0 +1,11 @@ +[android-components](../index.md) / [mozilla.components.browser.toolbar](./index.md) + +## Package mozilla.components.browser.toolbar + +### Types + +| Name | Summary | +|---|---| +| [AsyncAutocompleteDelegate](-async-autocomplete-delegate/index.md) | `class AsyncAutocompleteDelegate : `[`AutocompleteDelegate`](../mozilla.components.concept.toolbar/-autocomplete-delegate/index.md)`, CoroutineScope`
An autocomplete delegate which is aware of its parent scope (to check for cancellations). Responsible for processing autocompletion results and discarding stale results when [urlView](#) moved on. | +| [AsyncFilterListener](-async-filter-listener/index.md) | `class AsyncFilterListener : `[`OnFilterListener`](../mozilla.components.ui.autocomplete/-on-filter-listener.md)`, CoroutineScope`
Wraps [filter](#) execution in a coroutine context, cancelling prior executions on every invocation. [coroutineContext](-async-filter-listener/coroutine-context.md) must be of type that doesn't propagate cancellation of its children upwards. | +| [BrowserToolbar](-browser-toolbar/index.md) | `class BrowserToolbar : `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`, `[`Toolbar`](../mozilla.components.concept.toolbar/-toolbar/index.md)
A customizable toolbar for browsers. | diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md new file mode 100644 index 00000000000..179146d44b8 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md @@ -0,0 +1,31 @@ +[android-components](../../../index.md) / [mozilla.components.concept.awesomebar](../../index.md) / [AwesomeBar](../index.md) / [SuggestionProvider](./index.md) + +# SuggestionProvider + +`interface SuggestionProvider` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L119) + +A [SuggestionProvider](./index.md) is queried by an [AwesomeBar](../index.md) whenever the text in the address bar is changed by the user. +It returns a list of [Suggestion](../-suggestion/index.md)s to be displayed by the [AwesomeBar](../index.md). + +### Properties + +| Name | Summary | +|---|---| +| [shouldClearSuggestions](should-clear-suggestions.md) | `open val shouldClearSuggestions: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
If true an [AwesomeBar](../index.md) implementation can clear the previous suggestions of this provider as soon as the user continues to type. If this is false an [AwesomeBar](../index.md) implementation is allowed to keep the previous suggestions around until the provider returns a new list of suggestions for the updated text. | + +### Functions + +| Name | Summary | +|---|---| +| [onInputCancelled](on-input-cancelled.md) | `open fun onInputCancelled(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Fired when the user has cancelled their interaction with the awesome bar. | +| [onInputChanged](on-input-changed.md) | `abstract suspend fun onInputChanged(text: `[`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)`<`[`Suggestion`](../-suggestion/index.md)`>`
Fired whenever the user changes their input, after they have started interacting with the awesome bar. | +| [onInputStarted](on-input-started.md) | `open fun onInputStarted(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Fired when the user starts interacting with the awesome bar by entering text in the toolbar. | + +### Inheritors + +| Name | Summary | +|---|---| +| [ClipboardSuggestionProvider](../../../mozilla.components.feature.awesomebar.provider/-clipboard-suggestion-provider/index.md) | `class ClipboardSuggestionProvider : `[`SuggestionProvider`](./index.md)
An [AwesomeBar.SuggestionProvider](./index.md) implementation that returns a suggestions for an URL in the clipboard (if there's any). | +| [HistoryStorageSuggestionProvider](../../../mozilla.components.feature.awesomebar.provider/-history-storage-suggestion-provider/index.md) | `class HistoryStorageSuggestionProvider : `[`SuggestionProvider`](./index.md)
A [AwesomeBar.SuggestionProvider](./index.md) implementation that provides suggestions based on the browsing history stored in the [HistoryStorage](../../../mozilla.components.concept.storage/-history-storage/index.md). | +| [SearchSuggestionProvider](../../../mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/index.md) | `class SearchSuggestionProvider : `[`SuggestionProvider`](./index.md)
A [AwesomeBar.SuggestionProvider](./index.md) implementation that provides a suggestion containing search engine suggestions (as chips) from the passed in [SearchEngine](../../../mozilla.components.browser.search/-search-engine/index.md). | +| [SessionSuggestionProvider](../../../mozilla.components.feature.awesomebar.provider/-session-suggestion-provider/index.md) | `class SessionSuggestionProvider : `[`SuggestionProvider`](./index.md)
A [AwesomeBar.SuggestionProvider](./index.md) implementation that provides suggestions based on the sessions in the [SessionManager](../../../mozilla.components.browser.session/-session-manager/index.md) (Open tabs). | diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-cancelled.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-cancelled.md new file mode 100644 index 00000000000..af3d6a4f2df --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-cancelled.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.awesomebar](../../index.md) / [AwesomeBar](../index.md) / [SuggestionProvider](index.md) / [onInputCancelled](./on-input-cancelled.md) + +# onInputCancelled + +`open fun onInputCancelled(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L143) + +Fired when the user has cancelled their interaction with the awesome bar. + diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-changed.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-changed.md new file mode 100644 index 00000000000..e8c6a554af5 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-changed.md @@ -0,0 +1,22 @@ +[android-components](../../../index.md) / [mozilla.components.concept.awesomebar](../../index.md) / [AwesomeBar](../index.md) / [SuggestionProvider](index.md) / [onInputChanged](./on-input-changed.md) + +# onInputChanged + +`abstract suspend fun onInputChanged(text: `[`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)`<`[`Suggestion`](../-suggestion/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L138) + +Fired whenever the user changes their input, after they have started interacting with the awesome bar. + +This is a suspending function. An [AwesomeBar](../index.md) implementation is expected to invoke this method from a +[Coroutine](https://kotlinlang.org/docs/reference/coroutines-overview.html). This allows the [AwesomeBar](../index.md) +implementation to group and cancel calls to multiple providers. + +Coroutine cancellation is cooperative. A coroutine code has to cooperate to be cancellable: +https://github.com/Kotlin/kotlinx.coroutines/blob/master/docs/cancellation-and-timeouts.md + +### Parameters + +`text` - The current user input in the toolbar. + +**Return** +A list of suggestions to be displayed by the [AwesomeBar](../index.md). + diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-started.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-started.md new file mode 100644 index 00000000000..40514a4bf5c --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-started.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.awesomebar](../../index.md) / [AwesomeBar](../index.md) / [SuggestionProvider](index.md) / [onInputStarted](./on-input-started.md) + +# onInputStarted + +`open fun onInputStarted(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L123) + +Fired when the user starts interacting with the awesome bar by entering text in the toolbar. + diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/should-clear-suggestions.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/should-clear-suggestions.md new file mode 100644 index 00000000000..fb3da51adf1 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/should-clear-suggestions.md @@ -0,0 +1,10 @@ +[android-components](../../../index.md) / [mozilla.components.concept.awesomebar](../../index.md) / [AwesomeBar](../index.md) / [SuggestionProvider](index.md) / [shouldClearSuggestions](./should-clear-suggestions.md) + +# shouldClearSuggestions + +`open val shouldClearSuggestions: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L150) + +If true an [AwesomeBar](../index.md) implementation can clear the previous suggestions of this provider as soon as the +user continues to type. If this is false an [AwesomeBar](../index.md) implementation is allowed to keep the previous +suggestions around until the provider returns a new list of suggestions for the updated text. + diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-chip/-init-.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-chip/-init-.md new file mode 100644 index 00000000000..b6ca1ab49a2 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-chip/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.awesomebar](../../../index.md) / [AwesomeBar](../../index.md) / [Suggestion](../index.md) / [Chip](index.md) / [<init>](./-init-.md) + +# <init> + +`Chip(title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +Chips are compact actions that are shown as part of a suggestion. For example a [Suggestion](../index.md) from a search +engine may offer multiple search suggestion chips for different search terms. + diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-chip/index.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-chip/index.md new file mode 100644 index 00000000000..2ca85edf6e8 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-chip/index.md @@ -0,0 +1,20 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.awesomebar](../../../index.md) / [AwesomeBar](../../index.md) / [Suggestion](../index.md) / [Chip](./index.md) + +# Chip + +`data class Chip` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L86) + +Chips are compact actions that are shown as part of a suggestion. For example a [Suggestion](../index.md) from a search +engine may offer multiple search suggestion chips for different search terms. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Chip(title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
Chips are compact actions that are shown as part of a suggestion. For example a [Suggestion](../index.md) from a search engine may offer multiple search suggestion chips for different search terms. | + +### Properties + +| Name | Summary | +|---|---| +| [title](title.md) | `val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-chip/title.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-chip/title.md new file mode 100644 index 00000000000..c0a13e15954 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-chip/title.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.awesomebar](../../../index.md) / [AwesomeBar](../../index.md) / [Suggestion](../index.md) / [Chip](index.md) / [title](./title.md) + +# title + +`val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L87) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-flag/-b-o-o-k-m-a-r-k.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-flag/-b-o-o-k-m-a-r-k.md new file mode 100644 index 00000000000..89a82f5341f --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-flag/-b-o-o-k-m-a-r-k.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.awesomebar](../../../index.md) / [AwesomeBar](../../index.md) / [Suggestion](../index.md) / [Flag](index.md) / [BOOKMARK](./-b-o-o-k-m-a-r-k.md) + +# BOOKMARK + +`BOOKMARK` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L96) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-flag/-c-l-i-p-b-o-a-r-d.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-flag/-c-l-i-p-b-o-a-r-d.md new file mode 100644 index 00000000000..50038c1fb15 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-flag/-c-l-i-p-b-o-a-r-d.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.awesomebar](../../../index.md) / [AwesomeBar](../../index.md) / [Suggestion](../index.md) / [Flag](index.md) / [CLIPBOARD](./-c-l-i-p-b-o-a-r-d.md) + +# CLIPBOARD + +`CLIPBOARD` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L98) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-flag/-o-p-e-n_-t-a-b.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-flag/-o-p-e-n_-t-a-b.md new file mode 100644 index 00000000000..a9974ca1c5a --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-flag/-o-p-e-n_-t-a-b.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.awesomebar](../../../index.md) / [AwesomeBar](../../index.md) / [Suggestion](../index.md) / [Flag](index.md) / [OPEN_TAB](./-o-p-e-n_-t-a-b.md) + +# OPEN_TAB + +`OPEN_TAB` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L97) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-flag/index.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-flag/index.md new file mode 100644 index 00000000000..ad60b30a515 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-flag/index.md @@ -0,0 +1,17 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.awesomebar](../../../index.md) / [AwesomeBar](../../index.md) / [Suggestion](../index.md) / [Flag](./index.md) + +# Flag + +`enum class Flag` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L95) + +Flags can be added by a [SuggestionProvider](../../-suggestion-provider/index.md) to help the [AwesomeBar](../../index.md) implementation decide how to display +a specific [Suggestion](../index.md). For example an [AwesomeBar](../../index.md) could display a bookmark star icon next to [Suggestion](../index.md)s +that contain the [BOOKMARK](-b-o-o-k-m-a-r-k.md) flag. + +### Enum Values + +| Name | Summary | +|---|---| +| [BOOKMARK](-b-o-o-k-m-a-r-k.md) | | +| [OPEN_TAB](-o-p-e-n_-t-a-b.md) | | +| [CLIPBOARD](-c-l-i-p-b-o-a-r-d.md) | | diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-init-.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-init-.md new file mode 100644 index 00000000000..98dba3378c7 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.awesomebar](../../index.md) / [AwesomeBar](../index.md) / [Suggestion](index.md) / [<init>](./-init-.md) + +# <init> + +`Suggestion(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = UUID.randomUUID().toString(), title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, icon: (width: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, height: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`) -> `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`? = { _, _ -> null }, chips: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Chip`](-chip/index.md)`> = emptyList(), flags: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`Flag`](-flag/index.md)`> = emptySet(), onSuggestionClicked: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null, onChipClicked: (`[`Chip`](-chip/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null, score: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)` + +A [Suggestion](index.md) to be displayed by an [AwesomeBar](../index.md) implementation. + diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/are-contents-the-same.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/are-contents-the-same.md new file mode 100644 index 00000000000..1ffaf249cdc --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/are-contents-the-same.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.awesomebar](../../index.md) / [AwesomeBar](../index.md) / [Suggestion](index.md) / [areContentsTheSame](./are-contents-the-same.md) + +# areContentsTheSame + +`fun areContentsTheSame(other: `[`Suggestion`](index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L107) + +Returns true if the content of the two suggestions is the same. + +This is used by [AwesomeBar](../index.md) implementations to decide whether an updated suggestion (same id) needs its +view to be updated in order to display new data. + diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/chips.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/chips.md new file mode 100644 index 00000000000..ddee5c6e691 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/chips.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.awesomebar](../../index.md) / [AwesomeBar](../index.md) / [Suggestion](index.md) / [chips](./chips.md) + +# chips + +`val chips: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Chip`](-chip/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L76) + +A list of [Chip](-chip/index.md) instances to be displayed. + +### Property + +`chips` - A list of [Chip](-chip/index.md) instances to be displayed. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/description.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/description.md new file mode 100644 index 00000000000..b0692ed4767 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/description.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.awesomebar](../../index.md) / [AwesomeBar](../index.md) / [Suggestion](index.md) / [description](./description.md) + +# description + +`val description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L74) + +A user-readable description for the [Suggestion](index.md). + +### Property + +`description` - A user-readable description for the [Suggestion](index.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/flags.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/flags.md new file mode 100644 index 00000000000..caf1aca0964 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/flags.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.awesomebar](../../index.md) / [AwesomeBar](../index.md) / [Suggestion](index.md) / [flags](./flags.md) + +# flags + +`val flags: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`Flag`](-flag/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L77) + +A set of [Flag](-flag/index.md) values for this [Suggestion](index.md). + +### Property + +`flags` - A set of [Flag](-flag/index.md) values for this [Suggestion](index.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/icon.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/icon.md new file mode 100644 index 00000000000..94eca1eee1a --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/icon.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.awesomebar](../../index.md) / [AwesomeBar](../index.md) / [Suggestion](index.md) / [icon](./icon.md) + +# icon + +`val icon: (width: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, height: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`) -> `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L75) + +A lambda that can be invoked by the [AwesomeBar](../index.md) implementation to receive an icon [Bitmap](https://developer.android.com/reference/android/graphics/Bitmap.html) for +this [Suggestion](index.md). The [AwesomeBar](../index.md) will pass in its desired width and height for the Bitmap. + +### Property + +`icon` - A lambda that can be invoked by the [AwesomeBar](../index.md) implementation to receive an icon [Bitmap](https://developer.android.com/reference/android/graphics/Bitmap.html) for +this [Suggestion](index.md). The [AwesomeBar](../index.md) will pass in its desired width and height for the Bitmap. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/id.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/id.md new file mode 100644 index 00000000000..6094d740ede --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/id.md @@ -0,0 +1,15 @@ +[android-components](../../../index.md) / [mozilla.components.concept.awesomebar](../../index.md) / [AwesomeBar](../index.md) / [Suggestion](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L72) + +A unique ID identifying this [Suggestion](index.md). A stable ID but different data indicates to the +[AwesomeBar](../index.md) that this is the same [Suggestion](index.md) with new data. This will affect how the [AwesomeBar](../index.md) +animates showing the new suggestion. + +### Property + +`id` - A unique ID identifying this [Suggestion](index.md). A stable ID but different data indicates to the +[AwesomeBar](../index.md) that this is the same [Suggestion](index.md) with new data. This will affect how the [AwesomeBar](../index.md) +animates showing the new suggestion. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md new file mode 100644 index 00000000000..4671683e293 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md @@ -0,0 +1,40 @@ +[android-components](../../../index.md) / [mozilla.components.concept.awesomebar](../../index.md) / [AwesomeBar](../index.md) / [Suggestion](./index.md) + +# Suggestion + +`data class Suggestion` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L71) + +A [Suggestion](./index.md) to be displayed by an [AwesomeBar](../index.md) implementation. + +### Types + +| Name | Summary | +|---|---| +| [Chip](-chip/index.md) | `data class Chip`
Chips are compact actions that are shown as part of a suggestion. For example a [Suggestion](./index.md) from a search engine may offer multiple search suggestion chips for different search terms. | +| [Flag](-flag/index.md) | `enum class Flag`
Flags can be added by a [SuggestionProvider](../-suggestion-provider/index.md) to help the [AwesomeBar](../index.md) implementation decide how to display a specific [Suggestion](./index.md). For example an [AwesomeBar](../index.md) could display a bookmark star icon next to [Suggestion](./index.md)s that contain the [BOOKMARK](-flag/-b-o-o-k-m-a-r-k.md) flag. | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Suggestion(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = UUID.randomUUID().toString(), title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, icon: (width: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, height: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`) -> `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`? = { _, _ -> null }, chips: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Chip`](-chip/index.md)`> = emptyList(), flags: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`Flag`](-flag/index.md)`> = emptySet(), onSuggestionClicked: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null, onChipClicked: (`[`Chip`](-chip/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null, score: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)`
A [Suggestion](./index.md) to be displayed by an [AwesomeBar](../index.md) implementation. | + +### Properties + +| Name | Summary | +|---|---| +| [chips](chips.md) | `val chips: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Chip`](-chip/index.md)`>`
A list of [Chip](-chip/index.md) instances to be displayed. | +| [description](description.md) | `val description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
A user-readable description for the [Suggestion](./index.md). | +| [flags](flags.md) | `val flags: `[`Set`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)`<`[`Flag`](-flag/index.md)`>`
A set of [Flag](-flag/index.md) values for this [Suggestion](./index.md). | +| [icon](icon.md) | `val icon: (width: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, height: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`) -> `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?`
A lambda that can be invoked by the [AwesomeBar](../index.md) implementation to receive an icon [Bitmap](https://developer.android.com/reference/android/graphics/Bitmap.html) for this [Suggestion](./index.md). The [AwesomeBar](../index.md) will pass in its desired width and height for the Bitmap. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
A unique ID identifying this [Suggestion](./index.md). A stable ID but different data indicates to the [AwesomeBar](../index.md) that this is the same [Suggestion](./index.md) with new data. This will affect how the [AwesomeBar](../index.md) animates showing the new suggestion. | +| [onChipClicked](on-chip-clicked.md) | `val onChipClicked: (`[`Chip`](-chip/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
A callback to be executed when a [Chip](-chip/index.md) was clicked by the user. | +| [onSuggestionClicked](on-suggestion-clicked.md) | `val onSuggestionClicked: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
A callback to be executed when the [Suggestion](./index.md) was clicked by the user. | +| [score](score.md) | `val score: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
A score used to rank suggestions of this provider against each other. A suggestion with a higher score will be shown on top of suggestions with a lower score. | +| [title](title.md) | `val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
A user-readable title for the [Suggestion](./index.md). | + +### Functions + +| Name | Summary | +|---|---| +| [areContentsTheSame](are-contents-the-same.md) | `fun areContentsTheSame(other: `[`Suggestion`](./index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true if the content of the two suggestions is the same. | diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/on-chip-clicked.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/on-chip-clicked.md new file mode 100644 index 00000000000..cf52a38440d --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/on-chip-clicked.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.awesomebar](../../index.md) / [AwesomeBar](../index.md) / [Suggestion](index.md) / [onChipClicked](./on-chip-clicked.md) + +# onChipClicked + +`val onChipClicked: (`[`Chip`](-chip/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L79) + +A callback to be executed when a [Chip](-chip/index.md) was clicked by the user. + +### Property + +`onChipClicked` - A callback to be executed when a [Chip](-chip/index.md) was clicked by the user. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/on-suggestion-clicked.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/on-suggestion-clicked.md new file mode 100644 index 00000000000..fc5593a963b --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/on-suggestion-clicked.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.awesomebar](../../index.md) / [AwesomeBar](../index.md) / [Suggestion](index.md) / [onSuggestionClicked](./on-suggestion-clicked.md) + +# onSuggestionClicked + +`val onSuggestionClicked: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L78) + +A callback to be executed when the [Suggestion](index.md) was clicked by the user. + +### Property + +`onSuggestionClicked` - A callback to be executed when the [Suggestion](index.md) was clicked by the user. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/score.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/score.md new file mode 100644 index 00000000000..0b4ea64c80d --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/score.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.awesomebar](../../index.md) / [AwesomeBar](../index.md) / [Suggestion](index.md) / [score](./score.md) + +# score + +`val score: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L80) + +A score used to rank suggestions of this provider against each other. A suggestion with a higher +score will be shown on top of suggestions with a lower score. + +### Property + +`score` - A score used to rank suggestions of this provider against each other. A suggestion with a higher +score will be shown on top of suggestions with a lower score. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/title.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/title.md new file mode 100644 index 00000000000..cd67b068868 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/title.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.awesomebar](../../index.md) / [AwesomeBar](../index.md) / [Suggestion](index.md) / [title](./title.md) + +# title + +`val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L73) + +A user-readable title for the [Suggestion](index.md). + +### Property + +`title` - A user-readable title for the [Suggestion](index.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/add-providers.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/add-providers.md new file mode 100644 index 00000000000..ee157c2872f --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/add-providers.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.awesomebar](../index.md) / [AwesomeBar](index.md) / [addProviders](./add-providers.md) + +# addProviders + +`abstract fun addProviders(vararg providers: `[`SuggestionProvider`](-suggestion-provider/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L24) + +Adds the following [SuggestionProvider](-suggestion-provider/index.md) instances to be queried for [Suggestion](-suggestion/index.md)s whenever the text changes. + diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/as-view.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/as-view.md new file mode 100644 index 00000000000..9c910411e5a --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/as-view.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.awesomebar](../index.md) / [AwesomeBar](index.md) / [asView](./as-view.md) + +# asView + +`open fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L46) + +Casts this awesome bar to an Android View object. + diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/index.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/index.md new file mode 100644 index 00000000000..302a353b386 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/index.md @@ -0,0 +1,37 @@ +[android-components](../../index.md) / [mozilla.components.concept.awesomebar](../index.md) / [AwesomeBar](./index.md) + +# AwesomeBar + +`interface AwesomeBar` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L19) + +Interface to be implemented by awesome bar implementations. + +An awesome bar has multiple duties: + +* Display [Suggestion](-suggestion/index.md) instances and invoking its callbacks once selected +* React to outside events: [onInputStarted](on-input-started.md), [onInputChanged](on-input-changed.md), [onInputCancelled](on-input-cancelled.md). +* Query [SuggestionProvider](-suggestion-provider/index.md) instances for new suggestions when the text changes. + +### Types + +| Name | Summary | +|---|---| +| [Suggestion](-suggestion/index.md) | `data class Suggestion`
A [Suggestion](-suggestion/index.md) to be displayed by an [AwesomeBar](./index.md) implementation. | +| [SuggestionProvider](-suggestion-provider/index.md) | `interface SuggestionProvider`
A [SuggestionProvider](-suggestion-provider/index.md) is queried by an [AwesomeBar](./index.md) whenever the text in the address bar is changed by the user. It returns a list of [Suggestion](-suggestion/index.md)s to be displayed by the [AwesomeBar](./index.md). | + +### Functions + +| Name | Summary | +|---|---| +| [addProviders](add-providers.md) | `abstract fun addProviders(vararg providers: `[`SuggestionProvider`](-suggestion-provider/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Adds the following [SuggestionProvider](-suggestion-provider/index.md) instances to be queried for [Suggestion](-suggestion/index.md)s whenever the text changes. | +| [asView](as-view.md) | `open fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html)
Casts this awesome bar to an Android View object. | +| [onInputCancelled](on-input-cancelled.md) | `open fun onInputCancelled(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Fired when the user has cancelled their interaction with the awesome bar. | +| [onInputChanged](on-input-changed.md) | `abstract fun onInputChanged(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)
Fired whenever the user changes their input, after they have started interacting with the awesome bar. | +| [onInputStarted](on-input-started.md) | `open fun onInputStarted(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Fired when the user starts interacting with the awesome bar by entering text in the toolbar. | +| [setOnStopListener](set-on-stop-listener.md) | `abstract fun setOnStopListener(listener: () -> `[`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 lambda to be invoked when the user has finished interacting with the awesome bar (e.g. selected a suggestion). | + +### Inheritors + +| Name | Summary | +|---|---| +| [BrowserAwesomeBar](../../mozilla.components.browser.awesomebar/-browser-awesome-bar/index.md) | `class BrowserAwesomeBar : RecyclerView, `[`AwesomeBar`](./index.md)
A customizable [AwesomeBar](./index.md) implementation. | diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/on-input-cancelled.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/on-input-cancelled.md new file mode 100644 index 00000000000..3ef33a954b6 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/on-input-cancelled.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.awesomebar](../index.md) / [AwesomeBar](index.md) / [onInputCancelled](./on-input-cancelled.md) + +# onInputCancelled + +`open fun onInputCancelled(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L41) + +Fired when the user has cancelled their interaction with the awesome bar. + diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/on-input-changed.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/on-input-changed.md new file mode 100644 index 00000000000..88ff7f40e96 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/on-input-changed.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.awesomebar](../index.md) / [AwesomeBar](index.md) / [onInputChanged](./on-input-changed.md) + +# onInputChanged + +`abstract fun onInputChanged(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L36) + +Fired whenever the user changes their input, after they have started interacting with the awesome bar. + +### Parameters + +`text` - The current user input in the toolbar. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/on-input-started.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/on-input-started.md new file mode 100644 index 00000000000..f80c61429ef --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/on-input-started.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.awesomebar](../index.md) / [AwesomeBar](index.md) / [onInputStarted](./on-input-started.md) + +# onInputStarted + +`open fun onInputStarted(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L29) + +Fired when the user starts interacting with the awesome bar by entering text in the toolbar. + diff --git a/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/set-on-stop-listener.md b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/set-on-stop-listener.md new file mode 100644 index 00000000000..bb02e1238c7 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/-awesome-bar/set-on-stop-listener.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.concept.awesomebar](../index.md) / [AwesomeBar](index.md) / [setOnStopListener](./set-on-stop-listener.md) + +# setOnStopListener + +`abstract fun setOnStopListener(listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/awesomebar/src/main/java/mozilla/components/concept/awesomebar/AwesomeBar.kt#L52) + +Adds a lambda to be invoked when the user has finished interacting with the awesome bar (e.g. selected a +suggestion). + diff --git a/docs/api/mozilla.components.concept.awesomebar/index.md b/docs/api/mozilla.components.concept.awesomebar/index.md new file mode 100644 index 00000000000..165f5ec49e2 --- /dev/null +++ b/docs/api/mozilla.components.concept.awesomebar/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.concept.awesomebar](./index.md) + +## Package mozilla.components.concept.awesomebar + +### Types + +| Name | Summary | +|---|---| +| [AwesomeBar](-awesome-bar/index.md) | `interface AwesomeBar`
Interface to be implemented by awesome bar implementations. | diff --git a/docs/api/mozilla.components.concept.engine.history/-history-tracking-delegate/get-visited.md b/docs/api/mozilla.components.concept.engine.history/-history-tracking-delegate/get-visited.md new file mode 100644 index 00000000000..77c9b7b7a73 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.history/-history-tracking-delegate/get-visited.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.history](../index.md) / [HistoryTrackingDelegate](index.md) / [getVisited](./get-visited.md) + +# getVisited + +`abstract suspend fun getVisited(uris: `[`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`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/history/HistoryTrackingDelegate.kt#L28) + +An engine needs to know "visited" (true/false) status for provided URIs. + +`abstract suspend fun getVisited(): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/history/HistoryTrackingDelegate.kt#L33) + +An engine needs to know a list of all visited URIs. + diff --git a/docs/api/mozilla.components.concept.engine.history/-history-tracking-delegate/index.md b/docs/api/mozilla.components.concept.engine.history/-history-tracking-delegate/index.md new file mode 100644 index 00000000000..628268bc876 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.history/-history-tracking-delegate/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.history](../index.md) / [HistoryTrackingDelegate](./index.md) + +# HistoryTrackingDelegate + +`interface HistoryTrackingDelegate` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/history/HistoryTrackingDelegate.kt#L14) + +An interface used for providing history information to an engine (e.g. for link highlighting), +and receiving history updates from the engine (visits to URLs, title changes). + +Even though this interface is defined at the "concept" layer, its get* methods are tailored to +two types of engines which we support (system's WebView and GeckoView). + +### Functions + +| Name | Summary | +|---|---| +| [getVisited](get-visited.md) | `abstract suspend fun getVisited(uris: `[`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`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>`
An engine needs to know "visited" (true/false) status for provided URIs.`abstract suspend fun getVisited(): `[`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)`>`
An engine needs to know a list of all visited URIs. | +| [onTitleChanged](on-title-changed.md) | `abstract suspend fun onTitleChanged(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/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)
Title changed for a given URI. | +| [onVisited](on-visited.md) | `abstract suspend fun onVisited(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, isReload: `[`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)
A URI visit happened that an engine considers worthy of being recorded in browser's history. | + +### Inheritors + +| Name | Summary | +|---|---| +| [HistoryDelegate](../../mozilla.components.feature.session/-history-delegate/index.md) | `class HistoryDelegate : `[`HistoryTrackingDelegate`](./index.md)
Implementation of the [HistoryTrackingDelegate](./index.md) which delegates work to an instance of [HistoryStorage](../../mozilla.components.concept.storage/-history-storage/index.md). | diff --git a/docs/api/mozilla.components.concept.engine.history/-history-tracking-delegate/on-title-changed.md b/docs/api/mozilla.components.concept.engine.history/-history-tracking-delegate/on-title-changed.md new file mode 100644 index 00000000000..ad59d48b48a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.history/-history-tracking-delegate/on-title-changed.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.history](../index.md) / [HistoryTrackingDelegate](index.md) / [onTitleChanged](./on-title-changed.md) + +# onTitleChanged + +`abstract suspend fun onTitleChanged(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/history/HistoryTrackingDelegate.kt#L23) + +Title changed for a given URI. + diff --git a/docs/api/mozilla.components.concept.engine.history/-history-tracking-delegate/on-visited.md b/docs/api/mozilla.components.concept.engine.history/-history-tracking-delegate/on-visited.md new file mode 100644 index 00000000000..4a63824138e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.history/-history-tracking-delegate/on-visited.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.history](../index.md) / [HistoryTrackingDelegate](index.md) / [onVisited](./on-visited.md) + +# onVisited + +`abstract suspend fun onVisited(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, isReload: `[`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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/history/HistoryTrackingDelegate.kt#L18) + +A URI visit happened that an engine considers worthy of being recorded in browser's history. + diff --git a/docs/api/mozilla.components.concept.engine.history/index.md b/docs/api/mozilla.components.concept.engine.history/index.md new file mode 100644 index 00000000000..7d9957c2402 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.history/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.concept.engine.history](./index.md) + +## Package mozilla.components.concept.engine.history + +### Types + +| Name | Summary | +|---|---| +| [HistoryTrackingDelegate](-history-tracking-delegate/index.md) | `interface HistoryTrackingDelegate`
An interface used for providing history information to an engine (e.g. for link highlighting), and receiving history updates from the engine (visits to URLs, title changes). | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission-request/contains-video-and-audio-sources.md b/docs/api/mozilla.components.concept.engine.permission/-permission-request/contains-video-and-audio-sources.md new file mode 100644 index 00000000000..cf66a2f7f87 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission-request/contains-video-and-audio-sources.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.permission](../index.md) / [PermissionRequest](index.md) / [containsVideoAndAudioSources](./contains-video-and-audio-sources.md) + +# containsVideoAndAudioSources + +`open fun containsVideoAndAudioSources(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L54) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission-request/grant-if.md b/docs/api/mozilla.components.concept.engine.permission/-permission-request/grant-if.md new file mode 100644 index 00000000000..3d3f0ad59cd --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission-request/grant-if.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.permission](../index.md) / [PermissionRequest](index.md) / [grantIf](./grant-if.md) + +# grantIf + +`open fun grantIf(predicate: (`[`Permission`](../-permission/index.md)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L40) + +Grants this permission request if the provided predicate is true +for any of the requested permissions. + +### Parameters + +`predicate` - predicate to test for. + +**Return** +true if the permission request was granted, otherwise false. + diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission-request/grant.md b/docs/api/mozilla.components.concept.engine.permission/-permission-request/grant.md new file mode 100644 index 00000000000..1fe4047b1ae --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission-request/grant.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.permission](../index.md) / [PermissionRequest](index.md) / [grant](./grant.md) + +# grant + +`abstract fun grant(permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../-permission/index.md)`> = this.permissions): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L31) + +Grants the provided permissions, or all requested permissions, if none +are provided. + +### Parameters + +`permissions` - the permissions to grant. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission-request/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission-request/index.md new file mode 100644 index 00000000000..66c415d2063 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission-request/index.md @@ -0,0 +1,31 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.permission](../index.md) / [PermissionRequest](./index.md) + +# PermissionRequest + +`interface PermissionRequest` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L14) + +Represents a permission request, used when engines need access to protected +resources. Every request must be handled by either calling [grant](grant.md) or [reject](reject.md). + +### Properties + +| Name | Summary | +|---|---| +| [permissions](permissions.md) | `abstract val permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../-permission/index.md)`>`
List of requested permissions. | +| [uri](uri.md) | `abstract val uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
The origin URI which caused the permissions to be requested. | + +### Functions + +| Name | Summary | +|---|---| +| [containsVideoAndAudioSources](contains-video-and-audio-sources.md) | `open fun containsVideoAndAudioSources(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [grant](grant.md) | `abstract fun grant(permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../-permission/index.md)`> = this.permissions): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Grants the provided permissions, or all requested permissions, if none are provided. | +| [grantIf](grant-if.md) | `open fun grantIf(predicate: (`[`Permission`](../-permission/index.md)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Grants this permission request if the provided predicate is true for any of the requested permissions. | +| [reject](reject.md) | `abstract fun reject(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Rejects the requested permissions. | + +### Inheritors + +| Name | Summary | +|---|---| +| [GeckoPermissionRequest](../../mozilla.components.browser.engine.gecko.permission/-gecko-permission-request/index.md) | `sealed class GeckoPermissionRequest : `[`PermissionRequest`](./index.md)
Gecko-based implementation of [PermissionRequest](./index.md). | +| [SystemPermissionRequest](../../mozilla.components.browser.engine.system.permission/-system-permission-request/index.md) | `class SystemPermissionRequest : `[`PermissionRequest`](./index.md)
WebView-based implementation of [PermissionRequest](./index.md). | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission-request/permissions.md b/docs/api/mozilla.components.concept.engine.permission/-permission-request/permissions.md new file mode 100644 index 00000000000..9952f1e8014 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission-request/permissions.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.permission](../index.md) / [PermissionRequest](index.md) / [permissions](./permissions.md) + +# permissions + +`abstract val permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../-permission/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L23) + +List of requested permissions. + diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission-request/reject.md b/docs/api/mozilla.components.concept.engine.permission/-permission-request/reject.md new file mode 100644 index 00000000000..168d6f28579 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission-request/reject.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.permission](../index.md) / [PermissionRequest](index.md) / [reject](./reject.md) + +# reject + +`abstract fun reject(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L52) + +Rejects the requested permissions. + diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission-request/uri.md b/docs/api/mozilla.components.concept.engine.permission/-permission-request/uri.md new file mode 100644 index 00000000000..81e12afd470 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission-request/uri.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.permission](../index.md) / [PermissionRequest](index.md) / [uri](./uri.md) + +# uri + +`abstract val uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L18) + +The origin URI which caused the permissions to be requested. + diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-app-audio/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-audio/-init-.md new file mode 100644 index 00000000000..9111d729994 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-audio/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [AppAudio](index.md) / [<init>](./-init-.md) + +# <init> + +`AppAudio(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-app-audio/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-audio/desc.md new file mode 100644 index 00000000000..8e608affce9 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-audio/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [AppAudio](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L97) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-app-audio/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-audio/id.md new file mode 100644 index 00000000000..6e1686bd97c --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-audio/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [AppAudio](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L97) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-app-audio/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-audio/index.md new file mode 100644 index 00000000000..6782fbd0a8d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-audio/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [AppAudio](./index.md) + +# AppAudio + +`data class AppAudio : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L97) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AppAudio(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-app-camera/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-camera/-init-.md new file mode 100644 index 00000000000..3c1fc83fdf7 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-camera/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [AppCamera](index.md) / [<init>](./-init-.md) + +# <init> + +`AppCamera(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-app-camera/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-camera/desc.md new file mode 100644 index 00000000000..43111148543 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-camera/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [AppCamera](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L95) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-app-camera/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-camera/id.md new file mode 100644 index 00000000000..bcb5fa9ab91 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-camera/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [AppCamera](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L95) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-app-camera/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-camera/index.md new file mode 100644 index 00000000000..51a6f20261f --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-camera/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [AppCamera](./index.md) + +# AppCamera + +`data class AppCamera : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L95) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AppCamera(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-coarse/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-coarse/-init-.md new file mode 100644 index 00000000000..b7e55561437 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-coarse/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [AppLocationCoarse](index.md) / [<init>](./-init-.md) + +# <init> + +`AppLocationCoarse(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-coarse/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-coarse/desc.md new file mode 100644 index 00000000000..dfee633af50 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-coarse/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [AppLocationCoarse](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L99) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-coarse/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-coarse/id.md new file mode 100644 index 00000000000..8f509a5b224 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-coarse/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [AppLocationCoarse](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L99) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-coarse/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-coarse/index.md new file mode 100644 index 00000000000..7da33eabfc2 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-coarse/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [AppLocationCoarse](./index.md) + +# AppLocationCoarse + +`data class AppLocationCoarse : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L99) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AppLocationCoarse(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-fine/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-fine/-init-.md new file mode 100644 index 00000000000..b90df5b098b --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-fine/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [AppLocationFine](index.md) / [<init>](./-init-.md) + +# <init> + +`AppLocationFine(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-fine/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-fine/desc.md new file mode 100644 index 00000000000..a98828fbbd4 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-fine/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [AppLocationFine](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L101) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-fine/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-fine/id.md new file mode 100644 index 00000000000..d7fb2657489 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-fine/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [AppLocationFine](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L101) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-fine/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-fine/index.md new file mode 100644 index 00000000000..1f0532a073c --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-app-location-fine/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [AppLocationFine](./index.md) + +# AppLocationFine + +`data class AppLocationFine : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L101) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AppLocationFine(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-capture/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-capture/-init-.md new file mode 100644 index 00000000000..c0ec06efe96 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-capture/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentAudioCapture](index.md) / [<init>](./-init-.md) + +# <init> + +`ContentAudioCapture(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-capture/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-capture/desc.md new file mode 100644 index 00000000000..ec2f36ca62e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-capture/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentAudioCapture](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L66) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-capture/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-capture/id.md new file mode 100644 index 00000000000..8529bad61da --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-capture/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentAudioCapture](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L66) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-capture/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-capture/index.md new file mode 100644 index 00000000000..a774ca110de --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-capture/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentAudioCapture](./index.md) + +# ContentAudioCapture + +`data class ContentAudioCapture : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L66) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContentAudioCapture(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-microphone/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-microphone/-init-.md new file mode 100644 index 00000000000..9799f97bb02 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-microphone/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentAudioMicrophone](index.md) / [<init>](./-init-.md) + +# <init> + +`ContentAudioMicrophone(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-microphone/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-microphone/desc.md new file mode 100644 index 00000000000..40b25953da5 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-microphone/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentAudioMicrophone](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L68) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-microphone/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-microphone/id.md new file mode 100644 index 00000000000..90b71b9a00d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-microphone/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentAudioMicrophone](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L68) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-microphone/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-microphone/index.md new file mode 100644 index 00000000000..bceb843ff33 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-microphone/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentAudioMicrophone](./index.md) + +# ContentAudioMicrophone + +`data class ContentAudioMicrophone : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L68) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContentAudioMicrophone(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-other/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-other/-init-.md new file mode 100644 index 00000000000..04be8e713ee --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-other/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentAudioOther](index.md) / [<init>](./-init-.md) + +# <init> + +`ContentAudioOther(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-other/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-other/desc.md new file mode 100644 index 00000000000..389db415b2d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-other/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentAudioOther](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L70) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-other/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-other/id.md new file mode 100644 index 00000000000..f946816c1c3 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-other/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentAudioOther](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L70) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-other/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-other/index.md new file mode 100644 index 00000000000..968731d773c --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-audio-other/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentAudioOther](./index.md) + +# ContentAudioOther + +`data class ContentAudioOther : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L70) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContentAudioOther(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-autoplay-media/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-autoplay-media/-init-.md new file mode 100644 index 00000000000..0597962e846 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-autoplay-media/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentAutoplayMedia](index.md) / [<init>](./-init-.md) + +# <init> + +`ContentAutoplayMedia(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-autoplay-media/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-autoplay-media/desc.md new file mode 100644 index 00000000000..31f17e0678c --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-autoplay-media/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentAutoplayMedia](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L72) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-autoplay-media/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-autoplay-media/id.md new file mode 100644 index 00000000000..164091db6e4 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-autoplay-media/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentAutoplayMedia](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L72) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-autoplay-media/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-autoplay-media/index.md new file mode 100644 index 00000000000..166825de4d5 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-autoplay-media/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentAutoplayMedia](./index.md) + +# ContentAutoplayMedia + +`data class ContentAutoplayMedia : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L72) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContentAutoplayMedia(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-geo-location/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-geo-location/-init-.md new file mode 100644 index 00000000000..572f1553a1e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-geo-location/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentGeoLocation](index.md) / [<init>](./-init-.md) + +# <init> + +`ContentGeoLocation(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-geo-location/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-geo-location/desc.md new file mode 100644 index 00000000000..4606e8221fb --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-geo-location/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentGeoLocation](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L74) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-geo-location/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-geo-location/id.md new file mode 100644 index 00000000000..780a7b03257 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-geo-location/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentGeoLocation](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L74) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-geo-location/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-geo-location/index.md new file mode 100644 index 00000000000..64bfe9a1844 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-geo-location/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentGeoLocation](./index.md) + +# ContentGeoLocation + +`data class ContentGeoLocation : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L74) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContentGeoLocation(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-notification/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-notification/-init-.md new file mode 100644 index 00000000000..8a49c572d2a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-notification/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentNotification](index.md) / [<init>](./-init-.md) + +# <init> + +`ContentNotification(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-notification/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-notification/desc.md new file mode 100644 index 00000000000..4072ab2a01f --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-notification/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentNotification](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L76) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-notification/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-notification/id.md new file mode 100644 index 00000000000..a8654c95f8a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-notification/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentNotification](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L76) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-notification/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-notification/index.md new file mode 100644 index 00000000000..98899c317da --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-notification/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentNotification](./index.md) + +# ContentNotification + +`data class ContentNotification : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L76) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContentNotification(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-protected-media-id/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-protected-media-id/-init-.md new file mode 100644 index 00000000000..c6510d21707 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-protected-media-id/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentProtectedMediaId](index.md) / [<init>](./-init-.md) + +# <init> + +`ContentProtectedMediaId(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-protected-media-id/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-protected-media-id/desc.md new file mode 100644 index 00000000000..1752d2e8ced --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-protected-media-id/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentProtectedMediaId](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L78) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-protected-media-id/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-protected-media-id/id.md new file mode 100644 index 00000000000..c41fcfdeff3 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-protected-media-id/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentProtectedMediaId](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L78) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-protected-media-id/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-protected-media-id/index.md new file mode 100644 index 00000000000..deb64ecd9c0 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-protected-media-id/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentProtectedMediaId](./index.md) + +# ContentProtectedMediaId + +`data class ContentProtectedMediaId : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L78) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContentProtectedMediaId(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-application/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-application/-init-.md new file mode 100644 index 00000000000..3f504e73e85 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-application/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoApplication](index.md) / [<init>](./-init-.md) + +# <init> + +`ContentVideoApplication(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-application/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-application/desc.md new file mode 100644 index 00000000000..6c7498497a9 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-application/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoApplication](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L80) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-application/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-application/id.md new file mode 100644 index 00000000000..924f256da40 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-application/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoApplication](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L80) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-application/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-application/index.md new file mode 100644 index 00000000000..c017bda61d0 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-application/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoApplication](./index.md) + +# ContentVideoApplication + +`data class ContentVideoApplication : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L80) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContentVideoApplication(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-browser/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-browser/-init-.md new file mode 100644 index 00000000000..f936a271dbe --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-browser/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoBrowser](index.md) / [<init>](./-init-.md) + +# <init> + +`ContentVideoBrowser(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-browser/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-browser/desc.md new file mode 100644 index 00000000000..6ddb82cb34b --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-browser/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoBrowser](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L82) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-browser/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-browser/id.md new file mode 100644 index 00000000000..1b7b45c55d5 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-browser/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoBrowser](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L82) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-browser/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-browser/index.md new file mode 100644 index 00000000000..b60f082e26e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-browser/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoBrowser](./index.md) + +# ContentVideoBrowser + +`data class ContentVideoBrowser : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L82) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContentVideoBrowser(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-camera/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-camera/-init-.md new file mode 100644 index 00000000000..83f0b787957 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-camera/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoCamera](index.md) / [<init>](./-init-.md) + +# <init> + +`ContentVideoCamera(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-camera/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-camera/desc.md new file mode 100644 index 00000000000..d3eb7ed9939 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-camera/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoCamera](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L84) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-camera/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-camera/id.md new file mode 100644 index 00000000000..8b779f75fd8 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-camera/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoCamera](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L84) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-camera/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-camera/index.md new file mode 100644 index 00000000000..f788ba3ec9f --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-camera/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoCamera](./index.md) + +# ContentVideoCamera + +`data class ContentVideoCamera : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L84) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContentVideoCamera(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-capture/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-capture/-init-.md new file mode 100644 index 00000000000..46e4f8d94e1 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-capture/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoCapture](index.md) / [<init>](./-init-.md) + +# <init> + +`ContentVideoCapture(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-capture/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-capture/desc.md new file mode 100644 index 00000000000..1973bde1896 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-capture/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoCapture](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L86) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-capture/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-capture/id.md new file mode 100644 index 00000000000..08030e55336 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-capture/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoCapture](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L86) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-capture/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-capture/index.md new file mode 100644 index 00000000000..556a1430b34 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-capture/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoCapture](./index.md) + +# ContentVideoCapture + +`data class ContentVideoCapture : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L86) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContentVideoCapture(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-other/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-other/-init-.md new file mode 100644 index 00000000000..97365d16c74 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-other/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoOther](index.md) / [<init>](./-init-.md) + +# <init> + +`ContentVideoOther(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-other/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-other/desc.md new file mode 100644 index 00000000000..b9c8cf50b1d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-other/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoOther](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L92) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-other/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-other/id.md new file mode 100644 index 00000000000..6540ec566f5 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-other/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoOther](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L92) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-other/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-other/index.md new file mode 100644 index 00000000000..a1614fbb4c2 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-other/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoOther](./index.md) + +# ContentVideoOther + +`data class ContentVideoOther : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L92) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContentVideoOther(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-screen/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-screen/-init-.md new file mode 100644 index 00000000000..71958bca413 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-screen/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoScreen](index.md) / [<init>](./-init-.md) + +# <init> + +`ContentVideoScreen(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-screen/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-screen/desc.md new file mode 100644 index 00000000000..ff9f54d50ec --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-screen/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoScreen](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L88) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-screen/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-screen/id.md new file mode 100644 index 00000000000..9b7daa4674d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-screen/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoScreen](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L88) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-screen/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-screen/index.md new file mode 100644 index 00000000000..d57cf9a491e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-screen/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoScreen](./index.md) + +# ContentVideoScreen + +`data class ContentVideoScreen : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L88) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContentVideoScreen(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-window/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-window/-init-.md new file mode 100644 index 00000000000..1156ebf6d0c --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-window/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoWindow](index.md) / [<init>](./-init-.md) + +# <init> + +`ContentVideoWindow(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-window/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-window/desc.md new file mode 100644 index 00000000000..4fd6acad291 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-window/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoWindow](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L90) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-window/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-window/id.md new file mode 100644 index 00000000000..1e7706ba891 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-window/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoWindow](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L90) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-window/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-window/index.md new file mode 100644 index 00000000000..98ae84084e5 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-content-video-window/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [ContentVideoWindow](./index.md) + +# ContentVideoWindow + +`data class ContentVideoWindow : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L90) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContentVideoWindow(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "", desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-generic/-init-.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-generic/-init-.md new file mode 100644 index 00000000000..7fb8bfb4b0a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-generic/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [Generic](index.md) / [<init>](./-init-.md) + +# <init> + +`Generic(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-generic/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-generic/desc.md new file mode 100644 index 00000000000..f474450c5bb --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-generic/desc.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [Generic](index.md) / [desc](./desc.md) + +# desc + +`val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L104) + +Overrides [Permission.desc](../desc.md) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-generic/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-generic/id.md new file mode 100644 index 00000000000..271c0dbe84f --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-generic/id.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [Generic](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L104) + +Overrides [Permission.id](../id.md) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/-generic/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/-generic/index.md new file mode 100644 index 00000000000..f0dc84e5e1b --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/-generic/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.permission](../../index.md) / [Permission](../index.md) / [Generic](./index.md) + +# Generic + +`data class Generic : `[`Permission`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L104) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Generic(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = "")` | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/desc.md b/docs/api/mozilla.components.concept.engine.permission/-permission/desc.md new file mode 100644 index 00000000000..aac9996e1b3 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/desc.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.permission](../index.md) / [Permission](index.md) / [desc](./desc.md) + +# desc + +`open val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L64) + +an optional description of what this permission type is for. + +### Property + +`desc` - an optional description of what this permission type is for. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/id.md b/docs/api/mozilla.components.concept.engine.permission/-permission/id.md new file mode 100644 index 00000000000..dc30fe585e3 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/id.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.permission](../index.md) / [Permission](index.md) / [id](./id.md) + +# id + +`open val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L64) + +an optional native engine-specific ID of this permission. + +### Property + +`id` - an optional native engine-specific ID of this permission. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.permission/-permission/index.md b/docs/api/mozilla.components.concept.engine.permission/-permission/index.md new file mode 100644 index 00000000000..c72868e4399 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/-permission/index.md @@ -0,0 +1,62 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.permission](../index.md) / [Permission](./index.md) + +# Permission + +`sealed class Permission : `[`Parcelable`](https://developer.android.com/reference/android/os/Parcelable.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/permission/PermissionRequest.kt#L64) + +Represents all the different supported permission types. + +### Types + +| Name | Summary | +|---|---| +| [AppAudio](-app-audio/index.md) | `data class AppAudio : `[`Permission`](./index.md) | +| [AppCamera](-app-camera/index.md) | `data class AppCamera : `[`Permission`](./index.md) | +| [AppLocationCoarse](-app-location-coarse/index.md) | `data class AppLocationCoarse : `[`Permission`](./index.md) | +| [AppLocationFine](-app-location-fine/index.md) | `data class AppLocationFine : `[`Permission`](./index.md) | +| [ContentAudioCapture](-content-audio-capture/index.md) | `data class ContentAudioCapture : `[`Permission`](./index.md) | +| [ContentAudioMicrophone](-content-audio-microphone/index.md) | `data class ContentAudioMicrophone : `[`Permission`](./index.md) | +| [ContentAudioOther](-content-audio-other/index.md) | `data class ContentAudioOther : `[`Permission`](./index.md) | +| [ContentAutoplayMedia](-content-autoplay-media/index.md) | `data class ContentAutoplayMedia : `[`Permission`](./index.md) | +| [ContentGeoLocation](-content-geo-location/index.md) | `data class ContentGeoLocation : `[`Permission`](./index.md) | +| [ContentNotification](-content-notification/index.md) | `data class ContentNotification : `[`Permission`](./index.md) | +| [ContentProtectedMediaId](-content-protected-media-id/index.md) | `data class ContentProtectedMediaId : `[`Permission`](./index.md) | +| [ContentVideoApplication](-content-video-application/index.md) | `data class ContentVideoApplication : `[`Permission`](./index.md) | +| [ContentVideoBrowser](-content-video-browser/index.md) | `data class ContentVideoBrowser : `[`Permission`](./index.md) | +| [ContentVideoCamera](-content-video-camera/index.md) | `data class ContentVideoCamera : `[`Permission`](./index.md) | +| [ContentVideoCapture](-content-video-capture/index.md) | `data class ContentVideoCapture : `[`Permission`](./index.md) | +| [ContentVideoOther](-content-video-other/index.md) | `data class ContentVideoOther : `[`Permission`](./index.md) | +| [ContentVideoScreen](-content-video-screen/index.md) | `data class ContentVideoScreen : `[`Permission`](./index.md) | +| [ContentVideoWindow](-content-video-window/index.md) | `data class ContentVideoWindow : `[`Permission`](./index.md) | +| [Generic](-generic/index.md) | `data class Generic : `[`Permission`](./index.md) | + +### Properties + +| Name | Summary | +|---|---| +| [desc](desc.md) | `open val desc: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional description of what this permission type is for. | +| [id](id.md) | `open val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
an optional native engine-specific ID of this permission. | + +### Inheritors + +| Name | Summary | +|---|---| +| [AppAudio](-app-audio/index.md) | `data class AppAudio : `[`Permission`](./index.md) | +| [AppCamera](-app-camera/index.md) | `data class AppCamera : `[`Permission`](./index.md) | +| [AppLocationCoarse](-app-location-coarse/index.md) | `data class AppLocationCoarse : `[`Permission`](./index.md) | +| [AppLocationFine](-app-location-fine/index.md) | `data class AppLocationFine : `[`Permission`](./index.md) | +| [ContentAudioCapture](-content-audio-capture/index.md) | `data class ContentAudioCapture : `[`Permission`](./index.md) | +| [ContentAudioMicrophone](-content-audio-microphone/index.md) | `data class ContentAudioMicrophone : `[`Permission`](./index.md) | +| [ContentAudioOther](-content-audio-other/index.md) | `data class ContentAudioOther : `[`Permission`](./index.md) | +| [ContentAutoplayMedia](-content-autoplay-media/index.md) | `data class ContentAutoplayMedia : `[`Permission`](./index.md) | +| [ContentGeoLocation](-content-geo-location/index.md) | `data class ContentGeoLocation : `[`Permission`](./index.md) | +| [ContentNotification](-content-notification/index.md) | `data class ContentNotification : `[`Permission`](./index.md) | +| [ContentProtectedMediaId](-content-protected-media-id/index.md) | `data class ContentProtectedMediaId : `[`Permission`](./index.md) | +| [ContentVideoApplication](-content-video-application/index.md) | `data class ContentVideoApplication : `[`Permission`](./index.md) | +| [ContentVideoBrowser](-content-video-browser/index.md) | `data class ContentVideoBrowser : `[`Permission`](./index.md) | +| [ContentVideoCamera](-content-video-camera/index.md) | `data class ContentVideoCamera : `[`Permission`](./index.md) | +| [ContentVideoCapture](-content-video-capture/index.md) | `data class ContentVideoCapture : `[`Permission`](./index.md) | +| [ContentVideoOther](-content-video-other/index.md) | `data class ContentVideoOther : `[`Permission`](./index.md) | +| [ContentVideoScreen](-content-video-screen/index.md) | `data class ContentVideoScreen : `[`Permission`](./index.md) | +| [ContentVideoWindow](-content-video-window/index.md) | `data class ContentVideoWindow : `[`Permission`](./index.md) | +| [Generic](-generic/index.md) | `data class Generic : `[`Permission`](./index.md) | diff --git a/docs/api/mozilla.components.concept.engine.permission/index.md b/docs/api/mozilla.components.concept.engine.permission/index.md new file mode 100644 index 00000000000..d4ae6f3df60 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.permission/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.concept.engine.permission](./index.md) + +## Package mozilla.components.concept.engine.permission + +### Types + +| Name | Summary | +|---|---| +| [Permission](-permission/index.md) | `sealed class Permission : `[`Parcelable`](https://developer.android.com/reference/android/os/Parcelable.html)
Represents all the different supported permission types. | +| [PermissionRequest](-permission-request/index.md) | `interface PermissionRequest`
Represents a permission request, used when engines need access to protected resources. Every request must be handled by either calling [grant](-permission-request/grant.md) or [reject](-permission-request/reject.md). | diff --git a/docs/api/mozilla.components.concept.engine.prompt/-choice/-c-r-e-a-t-o-r/create-from-parcel.md b/docs/api/mozilla.components.concept.engine.prompt/-choice/-c-r-e-a-t-o-r/create-from-parcel.md new file mode 100644 index 00000000000..df41aec47dc --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-choice/-c-r-e-a-t-o-r/create-from-parcel.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [Choice](../index.md) / [CREATOR](index.md) / [createFromParcel](./create-from-parcel.md) + +# createFromParcel + +`fun createFromParcel(parcel: `[`Parcel`](https://developer.android.com/reference/android/os/Parcel.html)`): `[`Choice`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/Choice.kt#L55) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-choice/-c-r-e-a-t-o-r/index.md b/docs/api/mozilla.components.concept.engine.prompt/-choice/-c-r-e-a-t-o-r/index.md new file mode 100644 index 00000000000..f70f79ed16e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-choice/-c-r-e-a-t-o-r/index.md @@ -0,0 +1,12 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [Choice](../index.md) / [CREATOR](./index.md) + +# CREATOR + +`companion object CREATOR : `[`Creator`](https://developer.android.com/reference/android/os/Parcelable/Creator.html)`<`[`Choice`](../index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/Choice.kt#L54) + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [createFromParcel](create-from-parcel.md) | `fun createFromParcel(parcel: `[`Parcel`](https://developer.android.com/reference/android/os/Parcel.html)`): `[`Choice`](../index.md) | +| [newArray](new-array.md) | `fun newArray(size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../index.md)`?>` | diff --git a/docs/api/mozilla.components.concept.engine.prompt/-choice/-c-r-e-a-t-o-r/new-array.md b/docs/api/mozilla.components.concept.engine.prompt/-choice/-c-r-e-a-t-o-r/new-array.md new file mode 100644 index 00000000000..5a8a90f780f --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-choice/-c-r-e-a-t-o-r/new-array.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [Choice](../index.md) / [CREATOR](index.md) / [newArray](./new-array.md) + +# newArray + +`fun newArray(size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../index.md)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/Choice.kt#L59) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-choice/-init-.md b/docs/api/mozilla.components.concept.engine.prompt/-choice/-init-.md new file mode 100644 index 00000000000..802e956f567 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-choice/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.prompt](../index.md) / [Choice](index.md) / [<init>](./-init-.md) + +# <init> + +`Choice(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, selected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, isASeparator: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, children: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](index.md)`>? = null)` + +Value type that represents a select option, optgroup or menuitem html element. + diff --git a/docs/api/mozilla.components.concept.engine.prompt/-choice/children.md b/docs/api/mozilla.components.concept.engine.prompt/-choice/children.md new file mode 100644 index 00000000000..40dd2dc4b30 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-choice/children.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.prompt](../index.md) / [Choice](index.md) / [children](./children.md) + +# children + +`val children: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](index.md)`>?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/Choice.kt#L27) + +Sub-items in a group, or null if not a group. + +### Property + +`children` - Sub-items in a group, or null if not a group. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-choice/create-from-parcel.md b/docs/api/mozilla.components.concept.engine.prompt/-choice/create-from-parcel.md new file mode 100644 index 00000000000..567437581f3 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-choice/create-from-parcel.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.prompt](../index.md) / [Choice](index.md) / [createFromParcel](./create-from-parcel.md) + +# createFromParcel + +`fun createFromParcel(parcel: `[`Parcel`](https://developer.android.com/reference/android/os/Parcel.html)`): `[`Choice`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/Choice.kt#L55) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-choice/describe-contents.md b/docs/api/mozilla.components.concept.engine.prompt/-choice/describe-contents.md new file mode 100644 index 00000000000..1fd74b83196 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-choice/describe-contents.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.prompt](../index.md) / [Choice](index.md) / [describeContents](./describe-contents.md) + +# describeContents + +`fun describeContents(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/Choice.kt#L50) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-choice/enable.md b/docs/api/mozilla.components.concept.engine.prompt/-choice/enable.md new file mode 100644 index 00000000000..f7428ef4fd5 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-choice/enable.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.prompt](../index.md) / [Choice](index.md) / [enable](./enable.md) + +# enable + +`var enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/Choice.kt#L22) + +indicate if item should be selectable or not. + +### Property + +`enable` - indicate if item should be selectable or not. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-choice/id.md b/docs/api/mozilla.components.concept.engine.prompt/-choice/id.md new file mode 100644 index 00000000000..0a8a3c9db5f --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-choice/id.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.prompt](../index.md) / [Choice](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/Choice.kt#L21) + +of the option, optgroup or menuitem. + +### Property + +`id` - of the option, optgroup or menuitem. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-choice/index.md b/docs/api/mozilla.components.concept.engine.prompt/-choice/index.md new file mode 100644 index 00000000000..b7a4de29d37 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-choice/index.md @@ -0,0 +1,45 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.prompt](../index.md) / [Choice](./index.md) + +# Choice + +`data class Choice : `[`Parcelable`](https://developer.android.com/reference/android/os/Parcelable.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/Choice.kt#L20) + +Value type that represents a select option, optgroup or menuitem html element. + +### Types + +| Name | Summary | +|---|---| +| [CREATOR](-c-r-e-a-t-o-r/index.md) | `companion object CREATOR : `[`Creator`](https://developer.android.com/reference/android/os/Parcelable/Creator.html)`<`[`Choice`](./index.md)`>` | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Choice(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, selected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, isASeparator: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, children: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](./index.md)`>? = null)`
Value type that represents a select option, optgroup or menuitem html element. | + +### Properties + +| Name | Summary | +|---|---| +| [children](children.md) | `val children: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](./index.md)`>?`
Sub-items in a group, or null if not a group. | +| [enable](enable.md) | `var enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicate if item should be selectable or not. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
of the option, optgroup or menuitem. | +| [isASeparator](is-a-separator.md) | `val isASeparator: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicating if the item should be a menu separator (only valid for menus). | +| [isGroupType](is-group-type.md) | `val isGroupType: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [label](label.md) | `var label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The label for displaying the option, optgroup or menuitem. | +| [selected](selected.md) | `var selected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicate if the item should be pre-selected. | + +### Functions + +| Name | Summary | +|---|---| +| [describeContents](describe-contents.md) | `fun describeContents(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [writeToParcel](write-to-parcel.md) | `fun writeToParcel(parcel: `[`Parcel`](https://developer.android.com/reference/android/os/Parcel.html)`, flags: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [createFromParcel](create-from-parcel.md) | `fun createFromParcel(parcel: `[`Parcel`](https://developer.android.com/reference/android/os/Parcel.html)`): `[`Choice`](./index.md) | +| [newArray](new-array.md) | `fun newArray(size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](./index.md)`?>` | diff --git a/docs/api/mozilla.components.concept.engine.prompt/-choice/is-a-separator.md b/docs/api/mozilla.components.concept.engine.prompt/-choice/is-a-separator.md new file mode 100644 index 00000000000..c514c0d9c72 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-choice/is-a-separator.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.prompt](../index.md) / [Choice](index.md) / [isASeparator](./is-a-separator.md) + +# isASeparator + +`val isASeparator: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/Choice.kt#L25) + +Indicating if the item should be a menu separator (only valid for menus). + +### Property + +`isASeparator` - Indicating if the item should be a menu separator (only valid for menus). \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-choice/is-group-type.md b/docs/api/mozilla.components.concept.engine.prompt/-choice/is-group-type.md new file mode 100644 index 00000000000..df75b56a432 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-choice/is-group-type.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.prompt](../index.md) / [Choice](index.md) / [isGroupType](./is-group-type.md) + +# isGroupType + +`val isGroupType: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/Choice.kt#L30) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-choice/label.md b/docs/api/mozilla.components.concept.engine.prompt/-choice/label.md new file mode 100644 index 00000000000..a51689c05a4 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-choice/label.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.prompt](../index.md) / [Choice](index.md) / [label](./label.md) + +# label + +`var label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/Choice.kt#L23) + +The label for displaying the option, optgroup or menuitem. + +### Property + +`label` - The label for displaying the option, optgroup or menuitem. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-choice/new-array.md b/docs/api/mozilla.components.concept.engine.prompt/-choice/new-array.md new file mode 100644 index 00000000000..45d298f4c6e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-choice/new-array.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.prompt](../index.md) / [Choice](index.md) / [newArray](./new-array.md) + +# newArray + +`fun newArray(size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](index.md)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/Choice.kt#L59) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-choice/selected.md b/docs/api/mozilla.components.concept.engine.prompt/-choice/selected.md new file mode 100644 index 00000000000..ab4b4dec8ef --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-choice/selected.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.prompt](../index.md) / [Choice](index.md) / [selected](./selected.md) + +# selected + +`var selected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/Choice.kt#L24) + +Indicate if the item should be pre-selected. + +### Property + +`selected` - Indicate if the item should be pre-selected. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-choice/write-to-parcel.md b/docs/api/mozilla.components.concept.engine.prompt/-choice/write-to-parcel.md new file mode 100644 index 00000000000..b9e3f8f6b23 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-choice/write-to-parcel.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.prompt](../index.md) / [Choice](index.md) / [writeToParcel](./write-to-parcel.md) + +# writeToParcel + +`fun writeToParcel(parcel: `[`Parcel`](https://developer.android.com/reference/android/os/Parcel.html)`, flags: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/Choice.kt#L41) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/-init-.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/-init-.md new file mode 100644 index 00000000000..3801f73fa40 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Alert](index.md) / [<init>](./-init-.md) + +# <init> + +`Alert(title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, hasShownManyDialogs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onConfirm: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +Value type that represents a request for an alert prompt. + diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/has-shown-many-dialogs.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/has-shown-many-dialogs.md new file mode 100644 index 00000000000..98e3b5b2e30 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/has-shown-many-dialogs.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Alert](index.md) / [hasShownManyDialogs](./has-shown-many-dialogs.md) + +# hasShownManyDialogs + +`val hasShownManyDialogs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L47) + +tells if this page has shown multiple prompts within a short period of time. + +### Property + +`hasShownManyDialogs` - tells if this page has shown multiple prompts within a short period of time. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/index.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/index.md new file mode 100644 index 00000000000..e01fee30c2c --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/index.md @@ -0,0 +1,23 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Alert](./index.md) + +# Alert + +`data class Alert : `[`PromptRequest`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L44) + +Value type that represents a request for an alert prompt. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Alert(title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, hasShownManyDialogs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onConfirm: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
Value type that represents a request for an alert prompt. | + +### Properties + +| Name | Summary | +|---|---| +| [hasShownManyDialogs](has-shown-many-dialogs.md) | `val hasShownManyDialogs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
tells if this page has shown multiple prompts within a short period of time. | +| [message](message.md) | `val message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
the body of the dialog. | +| [onConfirm](on-confirm.md) | `val onConfirm: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
tells the web page if it should continue showing alerts or not. | +| [onDismiss](on-dismiss.md) | `val onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
callback to let the page know the user dismissed the dialog. | +| [title](title.md) | `val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
of the dialog. | diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/message.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/message.md new file mode 100644 index 00000000000..739614f5efb --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/message.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Alert](index.md) / [message](./message.md) + +# message + +`val message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L46) + +the body of the dialog. + +### Property + +`message` - the body of the dialog. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/on-confirm.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/on-confirm.md new file mode 100644 index 00000000000..5c1599a1fee --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/on-confirm.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Alert](index.md) / [onConfirm](./on-confirm.md) + +# onConfirm + +`val onConfirm: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L49) + +tells the web page if it should continue showing alerts or not. + +### Property + +`onConfirm` - tells the web page if it should continue showing alerts or not. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/on-dismiss.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/on-dismiss.md new file mode 100644 index 00000000000..d1943c3e50b --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/on-dismiss.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Alert](index.md) / [onDismiss](./on-dismiss.md) + +# onDismiss + +`val onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L48) + +callback to let the page know the user dismissed the dialog. + +### Property + +`onDismiss` - callback to let the page know the user dismissed the dialog. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/title.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/title.md new file mode 100644 index 00000000000..0b142872bb9 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-alert/title.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Alert](index.md) / [title](./title.md) + +# title + +`val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L45) + +of the dialog. + +### Property + +`title` - of the dialog. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-init-.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-init-.md new file mode 100644 index 00000000000..669be9a0dbb --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-init-.md @@ -0,0 +1,10 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Authentication](index.md) / [<init>](./-init-.md) + +# <init> + +`Authentication(title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, userName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, password: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, method: `[`Method`](-method/index.md)`, level: `[`Level`](-level/index.md)`, onlyShowPassword: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, previousFailed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, isCrossOrigin: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, onConfirm: (`[`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)`, onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +Value type that represents a request for an authentication prompt. +For more related info take a look at +<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication>MDN docs + diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-level/-n-o-n-e.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-level/-n-o-n-e.md new file mode 100644 index 00000000000..e55359ede43 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-level/-n-o-n-e.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.prompt](../../../index.md) / [PromptRequest](../../index.md) / [Authentication](../index.md) / [Level](index.md) / [NONE](./-n-o-n-e.md) + +# NONE + +`NONE` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L142) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-level/-p-a-s-s-w-o-r-d_-e-n-c-r-y-p-t-e-d.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-level/-p-a-s-s-w-o-r-d_-e-n-c-r-y-p-t-e-d.md new file mode 100644 index 00000000000..2d91d57ba4a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-level/-p-a-s-s-w-o-r-d_-e-n-c-r-y-p-t-e-d.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.prompt](../../../index.md) / [PromptRequest](../../index.md) / [Authentication](../index.md) / [Level](index.md) / [PASSWORD_ENCRYPTED](./-p-a-s-s-w-o-r-d_-e-n-c-r-y-p-t-e-d.md) + +# PASSWORD_ENCRYPTED + +`PASSWORD_ENCRYPTED` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L142) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-level/-s-e-c-u-r-e-d.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-level/-s-e-c-u-r-e-d.md new file mode 100644 index 00000000000..3af3cd5c2a9 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-level/-s-e-c-u-r-e-d.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.prompt](../../../index.md) / [PromptRequest](../../index.md) / [Authentication](../index.md) / [Level](index.md) / [SECURED](./-s-e-c-u-r-e-d.md) + +# SECURED + +`SECURED` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L142) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-level/index.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-level/index.md new file mode 100644 index 00000000000..758f7b2efeb --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-level/index.md @@ -0,0 +1,13 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.prompt](../../../index.md) / [PromptRequest](../../index.md) / [Authentication](../index.md) / [Level](./index.md) + +# Level + +`enum class Level` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L141) + +### Enum Values + +| Name | Summary | +|---|---| +| [NONE](-n-o-n-e.md) | | +| [PASSWORD_ENCRYPTED](-p-a-s-s-w-o-r-d_-e-n-c-r-y-p-t-e-d.md) | | +| [SECURED](-s-e-c-u-r-e-d.md) | | diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-method/-h-o-s-t.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-method/-h-o-s-t.md new file mode 100644 index 00000000000..e92d2aed005 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-method/-h-o-s-t.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.prompt](../../../index.md) / [PromptRequest](../../index.md) / [Authentication](../index.md) / [Method](index.md) / [HOST](./-h-o-s-t.md) + +# HOST + +`HOST` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L146) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-method/-p-r-o-x-y.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-method/-p-r-o-x-y.md new file mode 100644 index 00000000000..ec704ba3b84 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-method/-p-r-o-x-y.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.prompt](../../../index.md) / [PromptRequest](../../index.md) / [Authentication](../index.md) / [Method](index.md) / [PROXY](./-p-r-o-x-y.md) + +# PROXY + +`PROXY` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L146) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-method/index.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-method/index.md new file mode 100644 index 00000000000..6a4f9989566 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/-method/index.md @@ -0,0 +1,12 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.prompt](../../../index.md) / [PromptRequest](../../index.md) / [Authentication](../index.md) / [Method](./index.md) + +# Method + +`enum class Method` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L145) + +### Enum Values + +| Name | Summary | +|---|---| +| [HOST](-h-o-s-t.md) | | +| [PROXY](-p-r-o-x-y.md) | | diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/index.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/index.md new file mode 100644 index 00000000000..7eff80291bd --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/index.md @@ -0,0 +1,38 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Authentication](./index.md) + +# Authentication + +`data class Authentication : `[`PromptRequest`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L127) + +Value type that represents a request for an authentication prompt. +For more related info take a look at +<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication>MDN docs + +### Types + +| Name | Summary | +|---|---| +| [Level](-level/index.md) | `enum class Level` | +| [Method](-method/index.md) | `enum class Method` | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Authentication(title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, userName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, password: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, method: `[`Method`](-method/index.md)`, level: `[`Level`](-level/index.md)`, onlyShowPassword: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, previousFailed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, isCrossOrigin: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, onConfirm: (`[`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)`, onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
Value type that represents a request for an authentication prompt. For more related info take a look at <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication>MDN docs | + +### Properties + +| Name | Summary | +|---|---| +| [isCrossOrigin](is-cross-origin.md) | `val isCrossOrigin: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates if this request is from a cross-origin sub-resource. | +| [level](level.md) | `val level: `[`Level`](-level/index.md)
indicates the level of security of the authentication like [Level.NONE](-level/-n-o-n-e.md), [Level.SECURED](-level/-s-e-c-u-r-e-d.md) and [Level.PASSWORD_ENCRYPTED](-level/-p-a-s-s-w-o-r-d_-e-n-c-r-y-p-t-e-d.md). | +| [message](message.md) | `val message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
the body of the dialog. | +| [method](method.md) | `val method: `[`Method`](-method/index.md)
type of authentication, valid values [Method.HOST](-method/-h-o-s-t.md) and [Method.PROXY](-method/-p-r-o-x-y.md). | +| [onConfirm](on-confirm.md) | `val onConfirm: (`[`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)
callback to indicate the user want to start the authentication flow. | +| [onDismiss](on-dismiss.md) | `val onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
callback to indicate the user dismissed this request. | +| [onlyShowPassword](only-show-password.md) | `val onlyShowPassword: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates if the dialog should only include a password field. | +| [password](password.md) | `val password: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
default value provide for this session. | +| [previousFailed](previous-failed.md) | `val previousFailed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates if this request is the result of a previous failed attempt to login. | +| [title](title.md) | `val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
of the dialog. | +| [userName](user-name.md) | `val userName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
default value provide for this session. | diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/is-cross-origin.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/is-cross-origin.md new file mode 100644 index 00000000000..a7f360b7c09 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/is-cross-origin.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Authentication](index.md) / [isCrossOrigin](./is-cross-origin.md) + +# isCrossOrigin + +`val isCrossOrigin: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L136) + +indicates if this request is from a cross-origin sub-resource. + +### Property + +`isCrossOrigin` - indicates if this request is from a cross-origin sub-resource. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/level.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/level.md new file mode 100644 index 00000000000..3f57a30d917 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/level.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Authentication](index.md) / [level](./level.md) + +# level + +`val level: `[`Level`](-level/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L133) + +indicates the level of security of the authentication like [Level.NONE](-level/-n-o-n-e.md), +[Level.SECURED](-level/-s-e-c-u-r-e-d.md) and [Level.PASSWORD_ENCRYPTED](-level/-p-a-s-s-w-o-r-d_-e-n-c-r-y-p-t-e-d.md). + +### Property + +`level` - indicates the level of security of the authentication like [Level.NONE](-level/-n-o-n-e.md), +[Level.SECURED](-level/-s-e-c-u-r-e-d.md) and [Level.PASSWORD_ENCRYPTED](-level/-p-a-s-s-w-o-r-d_-e-n-c-r-y-p-t-e-d.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/message.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/message.md new file mode 100644 index 00000000000..a19673fa722 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/message.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Authentication](index.md) / [message](./message.md) + +# message + +`val message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L129) + +the body of the dialog. + +### Property + +`message` - the body of the dialog. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/method.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/method.md new file mode 100644 index 00000000000..20a1ca94db0 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/method.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Authentication](index.md) / [method](./method.md) + +# method + +`val method: `[`Method`](-method/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L132) + +type of authentication, valid values [Method.HOST](-method/-h-o-s-t.md) and [Method.PROXY](-method/-p-r-o-x-y.md). + +### Property + +`method` - type of authentication, valid values [Method.HOST](-method/-h-o-s-t.md) and [Method.PROXY](-method/-p-r-o-x-y.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/on-confirm.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/on-confirm.md new file mode 100644 index 00000000000..a44bd1744d9 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/on-confirm.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Authentication](index.md) / [onConfirm](./on-confirm.md) + +# onConfirm + +`val onConfirm: (`[`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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L137) + +callback to indicate the user want to start the authentication flow. + +### Property + +`onConfirm` - callback to indicate the user want to start the authentication flow. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/on-dismiss.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/on-dismiss.md new file mode 100644 index 00000000000..4c9a182446f --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/on-dismiss.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Authentication](index.md) / [onDismiss](./on-dismiss.md) + +# onDismiss + +`val onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L138) + +callback to indicate the user dismissed this request. + +### Property + +`onDismiss` - callback to indicate the user dismissed this request. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/only-show-password.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/only-show-password.md new file mode 100644 index 00000000000..eed903e000d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/only-show-password.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Authentication](index.md) / [onlyShowPassword](./only-show-password.md) + +# onlyShowPassword + +`val onlyShowPassword: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L134) + +indicates if the dialog should only include a password field. + +### Property + +`onlyShowPassword` - indicates if the dialog should only include a password field. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/password.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/password.md new file mode 100644 index 00000000000..570742b7262 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/password.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Authentication](index.md) / [password](./password.md) + +# password + +`val password: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L131) + +default value provide for this session. + +### Property + +`password` - default value provide for this session. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/previous-failed.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/previous-failed.md new file mode 100644 index 00000000000..6f06646ba33 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/previous-failed.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Authentication](index.md) / [previousFailed](./previous-failed.md) + +# previousFailed + +`val previousFailed: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L135) + +indicates if this request is the result of a previous failed attempt to login. + +### Property + +`previousFailed` - indicates if this request is the result of a previous failed attempt to login. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/title.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/title.md new file mode 100644 index 00000000000..30bca2a05c2 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/title.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Authentication](index.md) / [title](./title.md) + +# title + +`val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L128) + +of the dialog. + +### Property + +`title` - of the dialog. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/user-name.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/user-name.md new file mode 100644 index 00000000000..dbf8ad610ec --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-authentication/user-name.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Authentication](index.md) / [userName](./user-name.md) + +# userName + +`val userName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L130) + +default value provide for this session. + +### Property + +`userName` - default value provide for this session. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/-init-.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/-init-.md new file mode 100644 index 00000000000..15fb5918b9b --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Color](index.md) / [<init>](./-init-.md) + +# <init> + +`Color(defaultColor: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, onConfirm: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +Value type that represents a request for a selecting one or multiple files. + diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/default-color.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/default-color.md new file mode 100644 index 00000000000..f0b862b3288 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/default-color.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Color](index.md) / [defaultColor](./default-color.md) + +# defaultColor + +`val defaultColor: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L157) + +true if the user can select more that one file false otherwise. + +### Property + +`defaultColor` - true if the user can select more that one file false otherwise. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/index.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/index.md new file mode 100644 index 00000000000..6408eeda434 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/index.md @@ -0,0 +1,21 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Color](./index.md) + +# Color + +`data class Color : `[`PromptRequest`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L156) + +Value type that represents a request for a selecting one or multiple files. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Color(defaultColor: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, onConfirm: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
Value type that represents a request for a selecting one or multiple files. | + +### Properties + +| Name | Summary | +|---|---| +| [defaultColor](default-color.md) | `val defaultColor: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
true if the user can select more that one file false otherwise. | +| [onConfirm](on-confirm.md) | `val onConfirm: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
callback to notify that the user has selected a color. | +| [onDismiss](on-dismiss.md) | `val onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
callback to notify that the user has canceled the dialog. | diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/on-confirm.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/on-confirm.md new file mode 100644 index 00000000000..5a511e40f59 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/on-confirm.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Color](index.md) / [onConfirm](./on-confirm.md) + +# onConfirm + +`val onConfirm: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L158) + +callback to notify that the user has selected a color. + +### Property + +`onConfirm` - callback to notify that the user has selected a color. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/on-dismiss.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/on-dismiss.md new file mode 100644 index 00000000000..f3997e4aebd --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-color/on-dismiss.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Color](index.md) / [onDismiss](./on-dismiss.md) + +# onDismiss + +`val onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L159) + +callback to notify that the user has canceled the dialog. + +### Property + +`onDismiss` - callback to notify that the user has canceled the dialog. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/-init-.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/-init-.md new file mode 100644 index 00000000000..879d7bc6685 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/-init-.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Confirm](index.md) / [<init>](./-init-.md) + +# <init> + +`Confirm(title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, hasShownManyDialogs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, positiveButtonTitle: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "", negativeButtonTitle: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "", neutralButtonTitle: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "", onConfirmPositiveButton: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onConfirmNegativeButton: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onConfirmNeutralButton: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +Value type that represents a request for showing a +<a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/confirm>confirm prompt. + +The prompt can have up to three buttons, they could be positive, negative and neutral. + diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/has-shown-many-dialogs.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/has-shown-many-dialogs.md new file mode 100644 index 00000000000..8559fa163e5 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/has-shown-many-dialogs.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Confirm](index.md) / [hasShownManyDialogs](./has-shown-many-dialogs.md) + +# hasShownManyDialogs + +`val hasShownManyDialogs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L197) + +tells if this page has shown multiple prompts within a short period of time. + +### Property + +`hasShownManyDialogs` - tells if this page has shown multiple prompts within a short period of time. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/index.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/index.md new file mode 100644 index 00000000000..8cd77dfe8d4 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/index.md @@ -0,0 +1,31 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Confirm](./index.md) + +# Confirm + +`data class Confirm : `[`PromptRequest`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L194) + +Value type that represents a request for showing a +<a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/confirm>confirm prompt. + +The prompt can have up to three buttons, they could be positive, negative and neutral. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Confirm(title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, hasShownManyDialogs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, positiveButtonTitle: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "", negativeButtonTitle: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "", neutralButtonTitle: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "", onConfirmPositiveButton: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onConfirmNegativeButton: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onConfirmNeutralButton: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
Value type that represents a request for showing a <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/confirm>confirm prompt. | + +### Properties + +| Name | Summary | +|---|---| +| [hasShownManyDialogs](has-shown-many-dialogs.md) | `val hasShownManyDialogs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
tells if this page has shown multiple prompts within a short period of time. | +| [message](message.md) | `val message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
the body of the dialog. | +| [negativeButtonTitle](negative-button-title.md) | `val negativeButtonTitle: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
optional title for the negative button. | +| [neutralButtonTitle](neutral-button-title.md) | `val neutralButtonTitle: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
optional title for the neutral button. | +| [onConfirmNegativeButton](on-confirm-negative-button.md) | `val onConfirmNegativeButton: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
callback to notify that the user has clicked the negative button. | +| [onConfirmNeutralButton](on-confirm-neutral-button.md) | `val onConfirmNeutralButton: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
callback to notify that the user has clicked the neutral button. | +| [onConfirmPositiveButton](on-confirm-positive-button.md) | `val onConfirmPositiveButton: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
callback to notify that the user has clicked the positive button. | +| [onDismiss](on-dismiss.md) | `val onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
callback to notify that the user has canceled the dialog. | +| [positiveButtonTitle](positive-button-title.md) | `val positiveButtonTitle: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
optional title for the positive button. | +| [title](title.md) | `val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
of the dialog. | diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/message.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/message.md new file mode 100644 index 00000000000..c15435b36a2 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/message.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Confirm](index.md) / [message](./message.md) + +# message + +`val message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L196) + +the body of the dialog. + +### Property + +`message` - the body of the dialog. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/negative-button-title.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/negative-button-title.md new file mode 100644 index 00000000000..db7d9ca0a15 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/negative-button-title.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Confirm](index.md) / [negativeButtonTitle](./negative-button-title.md) + +# negativeButtonTitle + +`val negativeButtonTitle: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L199) + +optional title for the negative button. + +### Property + +`negativeButtonTitle` - optional title for the negative button. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/neutral-button-title.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/neutral-button-title.md new file mode 100644 index 00000000000..064217eb3a3 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/neutral-button-title.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Confirm](index.md) / [neutralButtonTitle](./neutral-button-title.md) + +# neutralButtonTitle + +`val neutralButtonTitle: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L200) + +optional title for the neutral button. + +### Property + +`neutralButtonTitle` - optional title for the neutral button. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/on-confirm-negative-button.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/on-confirm-negative-button.md new file mode 100644 index 00000000000..1fe962c200b --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/on-confirm-negative-button.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Confirm](index.md) / [onConfirmNegativeButton](./on-confirm-negative-button.md) + +# onConfirmNegativeButton + +`val onConfirmNegativeButton: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L202) + +callback to notify that the user has clicked the negative button. + +### Property + +`onConfirmNegativeButton` - callback to notify that the user has clicked the negative button. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/on-confirm-neutral-button.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/on-confirm-neutral-button.md new file mode 100644 index 00000000000..6dca576c71f --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/on-confirm-neutral-button.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Confirm](index.md) / [onConfirmNeutralButton](./on-confirm-neutral-button.md) + +# onConfirmNeutralButton + +`val onConfirmNeutralButton: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L203) + +callback to notify that the user has clicked the neutral button. + +### Property + +`onConfirmNeutralButton` - callback to notify that the user has clicked the neutral button. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/on-confirm-positive-button.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/on-confirm-positive-button.md new file mode 100644 index 00000000000..d63d763857a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/on-confirm-positive-button.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Confirm](index.md) / [onConfirmPositiveButton](./on-confirm-positive-button.md) + +# onConfirmPositiveButton + +`val onConfirmPositiveButton: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L201) + +callback to notify that the user has clicked the positive button. + +### Property + +`onConfirmPositiveButton` - callback to notify that the user has clicked the positive button. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/on-dismiss.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/on-dismiss.md new file mode 100644 index 00000000000..9b862c92267 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/on-dismiss.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Confirm](index.md) / [onDismiss](./on-dismiss.md) + +# onDismiss + +`val onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L204) + +callback to notify that the user has canceled the dialog. + +### Property + +`onDismiss` - callback to notify that the user has canceled the dialog. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/positive-button-title.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/positive-button-title.md new file mode 100644 index 00000000000..4386c4bd8cd --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/positive-button-title.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Confirm](index.md) / [positiveButtonTitle](./positive-button-title.md) + +# positiveButtonTitle + +`val positiveButtonTitle: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L198) + +optional title for the positive button. + +### Property + +`positiveButtonTitle` - optional title for the positive button. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/title.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/title.md new file mode 100644 index 00000000000..bd4f4e5c5fd --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-confirm/title.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Confirm](index.md) / [title](./title.md) + +# title + +`val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L195) + +of the dialog. + +### Property + +`title` - of the dialog. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/-init-.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/-init-.md new file mode 100644 index 00000000000..536a5a93604 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [File](index.md) / [<init>](./-init-.md) + +# <init> + +`File(mimeTypes: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`, isMultipleFilesSelection: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, onSingleFileSelected: (`[`Context`](https://developer.android.com/reference/android/content/Context.html)`, `[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onMultipleFilesSelected: (`[`Context`](https://developer.android.com/reference/android/content/Context.html)`, `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`>) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +Value type that represents a request for a selecting one or multiple files. + diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/index.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/index.md new file mode 100644 index 00000000000..3d0adbcdb08 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/index.md @@ -0,0 +1,23 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [File](./index.md) + +# File + +`data class File : `[`PromptRequest`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L102) + +Value type that represents a request for a selecting one or multiple files. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `File(mimeTypes: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`, isMultipleFilesSelection: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, onSingleFileSelected: (`[`Context`](https://developer.android.com/reference/android/content/Context.html)`, `[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onMultipleFilesSelected: (`[`Context`](https://developer.android.com/reference/android/content/Context.html)`, `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`>) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
Value type that represents a request for a selecting one or multiple files. | + +### Properties + +| Name | Summary | +|---|---| +| [isMultipleFilesSelection](is-multiple-files-selection.md) | `val isMultipleFilesSelection: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
true if the user can select more that one file false otherwise. | +| [mimeTypes](mime-types.md) | `val mimeTypes: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)``
a set of allowed mime types. Only these file types can be selected. | +| [onDismiss](on-dismiss.md) | `val onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
callback to notify that the user has canceled the file selection. | +| [onMultipleFilesSelected](on-multiple-files-selected.md) | `val onMultipleFilesSelected: (`[`Context`](https://developer.android.com/reference/android/content/Context.html)`, `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`>) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
callback to notify that the user has selected multiple files. | +| [onSingleFileSelected](on-single-file-selected.md) | `val onSingleFileSelected: (`[`Context`](https://developer.android.com/reference/android/content/Context.html)`, `[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
callback to notify that the user has selected a single file. | diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/is-multiple-files-selection.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/is-multiple-files-selection.md new file mode 100644 index 00000000000..aa36dc00ef4 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/is-multiple-files-selection.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [File](index.md) / [isMultipleFilesSelection](./is-multiple-files-selection.md) + +# isMultipleFilesSelection + +`val isMultipleFilesSelection: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L104) + +true if the user can select more that one file false otherwise. + +### Property + +`isMultipleFilesSelection` - true if the user can select more that one file false otherwise. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/mime-types.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/mime-types.md new file mode 100644 index 00000000000..e80ac596ab0 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/mime-types.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [File](index.md) / [mimeTypes](./mime-types.md) + +# mimeTypes + +`val mimeTypes: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L103) + +a set of allowed mime types. Only these file types can be selected. + +### Property + +`mimeTypes` - a set of allowed mime types. Only these file types can be selected. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/on-dismiss.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/on-dismiss.md new file mode 100644 index 00000000000..368039c2bec --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/on-dismiss.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [File](index.md) / [onDismiss](./on-dismiss.md) + +# onDismiss + +`val onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L107) + +callback to notify that the user has canceled the file selection. + +### Property + +`onDismiss` - callback to notify that the user has canceled the file selection. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/on-multiple-files-selected.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/on-multiple-files-selected.md new file mode 100644 index 00000000000..c219bd8692f --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/on-multiple-files-selected.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [File](index.md) / [onMultipleFilesSelected](./on-multiple-files-selected.md) + +# onMultipleFilesSelected + +`val onMultipleFilesSelected: (`[`Context`](https://developer.android.com/reference/android/content/Context.html)`, `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`>) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L106) + +callback to notify that the user has selected multiple files. + +### Property + +`onMultipleFilesSelected` - callback to notify that the user has selected multiple files. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/on-single-file-selected.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/on-single-file-selected.md new file mode 100644 index 00000000000..4551d29208a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-file/on-single-file-selected.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [File](index.md) / [onSingleFileSelected](./on-single-file-selected.md) + +# onSingleFileSelected + +`val onSingleFileSelected: (`[`Context`](https://developer.android.com/reference/android/content/Context.html)`, `[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L105) + +callback to notify that the user has selected a single file. + +### Property + +`onSingleFileSelected` - callback to notify that the user has selected a single file. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-menu-choice/-init-.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-menu-choice/-init-.md new file mode 100644 index 00000000000..5a378eaca5c --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-menu-choice/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [MenuChoice](index.md) / [<init>](./-init-.md) + +# <init> + +`MenuChoice(choices: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../../-choice/index.md)`>, onConfirm: (`[`Choice`](../../-choice/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +Value type that represents a request for a menu choice prompt. + diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-menu-choice/choices.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-menu-choice/choices.md new file mode 100644 index 00000000000..be3d35c7573 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-menu-choice/choices.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [MenuChoice](index.md) / [choices](./choices.md) + +# choices + +`val choices: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../../-choice/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L34) + +All the possible options. + +### Property + +`choices` - All the possible options. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-menu-choice/index.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-menu-choice/index.md new file mode 100644 index 00000000000..af7b61bab28 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-menu-choice/index.md @@ -0,0 +1,20 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [MenuChoice](./index.md) + +# MenuChoice + +`data class MenuChoice : `[`PromptRequest`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L34) + +Value type that represents a request for a menu choice prompt. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `MenuChoice(choices: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../../-choice/index.md)`>, onConfirm: (`[`Choice`](../../-choice/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
Value type that represents a request for a menu choice prompt. | + +### Properties + +| Name | Summary | +|---|---| +| [choices](choices.md) | `val choices: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../../-choice/index.md)`>`
All the possible options. | +| [onConfirm](on-confirm.md) | `val onConfirm: (`[`Choice`](../../-choice/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
A callback indicating which option was selected. | diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-menu-choice/on-confirm.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-menu-choice/on-confirm.md new file mode 100644 index 00000000000..994e3d7953c --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-menu-choice/on-confirm.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [MenuChoice](index.md) / [onConfirm](./on-confirm.md) + +# onConfirm + +`val onConfirm: (`[`Choice`](../../-choice/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L34) + +A callback indicating which option was selected. + +### Property + +`onConfirm` - A callback indicating which option was selected. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-multiple-choice/-init-.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-multiple-choice/-init-.md new file mode 100644 index 00000000000..36164d0c107 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-multiple-choice/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [MultipleChoice](index.md) / [<init>](./-init-.md) + +# <init> + +`MultipleChoice(choices: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../../-choice/index.md)`>, onConfirm: (`[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../../-choice/index.md)`>) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +Value type that represents a request for a multiple choice prompt. + diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-multiple-choice/choices.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-multiple-choice/choices.md new file mode 100644 index 00000000000..8f84c0e4608 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-multiple-choice/choices.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [MultipleChoice](index.md) / [choices](./choices.md) + +# choices + +`val choices: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../../-choice/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L27) + +All the possible options. + +### Property + +`choices` - All the possible options. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-multiple-choice/index.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-multiple-choice/index.md new file mode 100644 index 00000000000..d05a1d45fc8 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-multiple-choice/index.md @@ -0,0 +1,20 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [MultipleChoice](./index.md) + +# MultipleChoice + +`data class MultipleChoice : `[`PromptRequest`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L27) + +Value type that represents a request for a multiple choice prompt. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `MultipleChoice(choices: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../../-choice/index.md)`>, onConfirm: (`[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../../-choice/index.md)`>) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
Value type that represents a request for a multiple choice prompt. | + +### Properties + +| Name | Summary | +|---|---| +| [choices](choices.md) | `val choices: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../../-choice/index.md)`>`
All the possible options. | +| [onConfirm](on-confirm.md) | `val onConfirm: (`[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../../-choice/index.md)`>) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
A callback indicating witch options has been selected. | diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-multiple-choice/on-confirm.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-multiple-choice/on-confirm.md new file mode 100644 index 00000000000..f93a08ec288 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-multiple-choice/on-confirm.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [MultipleChoice](index.md) / [onConfirm](./on-confirm.md) + +# onConfirm + +`val onConfirm: (`[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../../-choice/index.md)`>) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L27) + +A callback indicating witch options has been selected. + +### Property + +`onConfirm` - A callback indicating witch options has been selected. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/-init-.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/-init-.md new file mode 100644 index 00000000000..c553fa97eb1 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/-init-.md @@ -0,0 +1,10 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Popup](index.md) / [<init>](./-init-.md) + +# <init> + +`Popup(targetUri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, onAllow: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onDeny: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +Value type that represents a request for showing a pop-pup prompt. +This occurs when content attempts to open a new window, +in a way that doesn't appear to be the result of user input. + diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/index.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/index.md new file mode 100644 index 00000000000..571a2079129 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/index.md @@ -0,0 +1,23 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Popup](./index.md) + +# Popup + +`data class Popup : `[`PromptRequest`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L171) + +Value type that represents a request for showing a pop-pup prompt. +This occurs when content attempts to open a new window, +in a way that doesn't appear to be the result of user input. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Popup(targetUri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, onAllow: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onDeny: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
Value type that represents a request for showing a pop-pup prompt. This occurs when content attempts to open a new window, in a way that doesn't appear to be the result of user input. | + +### Properties + +| Name | Summary | +|---|---| +| [onAllow](on-allow.md) | `val onAllow: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
callback to notify that the user wants to open the [targetUri](target-uri.md). | +| [onDeny](on-deny.md) | `val onDeny: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
callback to notify that the user doesn't want to open the [targetUri](target-uri.md). | +| [targetUri](target-uri.md) | `val targetUri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
the uri that the page is trying to open. | diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/on-allow.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/on-allow.md new file mode 100644 index 00000000000..5e686706bed --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/on-allow.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Popup](index.md) / [onAllow](./on-allow.md) + +# onAllow + +`val onAllow: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L173) + +callback to notify that the user wants to open the [targetUri](target-uri.md). + +### Property + +`onAllow` - callback to notify that the user wants to open the [targetUri](target-uri.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/on-deny.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/on-deny.md new file mode 100644 index 00000000000..13732ca4bf4 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/on-deny.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Popup](index.md) / [onDeny](./on-deny.md) + +# onDeny + +`val onDeny: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L174) + +callback to notify that the user doesn't want to open the [targetUri](target-uri.md). + +### Property + +`onDeny` - callback to notify that the user doesn't want to open the [targetUri](target-uri.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/target-uri.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/target-uri.md new file mode 100644 index 00000000000..e7ed79e7749 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-popup/target-uri.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [Popup](index.md) / [targetUri](./target-uri.md) + +# targetUri + +`val targetUri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L172) + +the uri that the page is trying to open. + +### Property + +`targetUri` - the uri that the page is trying to open. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-single-choice/-init-.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-single-choice/-init-.md new file mode 100644 index 00000000000..947cc7236eb --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-single-choice/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [SingleChoice](index.md) / [<init>](./-init-.md) + +# <init> + +`SingleChoice(choices: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../../-choice/index.md)`>, onConfirm: (`[`Choice`](../../-choice/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +Value type that represents a request for a single choice prompt. + diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-single-choice/choices.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-single-choice/choices.md new file mode 100644 index 00000000000..7db4ec2fbe6 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-single-choice/choices.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [SingleChoice](index.md) / [choices](./choices.md) + +# choices + +`val choices: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../../-choice/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L20) + +All the possible options. + +### Property + +`choices` - All the possible options. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-single-choice/index.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-single-choice/index.md new file mode 100644 index 00000000000..1cb8d188aa8 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-single-choice/index.md @@ -0,0 +1,20 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [SingleChoice](./index.md) + +# SingleChoice + +`data class SingleChoice : `[`PromptRequest`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L20) + +Value type that represents a request for a single choice prompt. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SingleChoice(choices: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../../-choice/index.md)`>, onConfirm: (`[`Choice`](../../-choice/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
Value type that represents a request for a single choice prompt. | + +### Properties + +| Name | Summary | +|---|---| +| [choices](choices.md) | `val choices: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Choice`](../../-choice/index.md)`>`
All the possible options. | +| [onConfirm](on-confirm.md) | `val onConfirm: (`[`Choice`](../../-choice/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
A callback indicating which option was selected. | diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-single-choice/on-confirm.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-single-choice/on-confirm.md new file mode 100644 index 00000000000..6e3ebca7fbc --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-single-choice/on-confirm.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [SingleChoice](index.md) / [onConfirm](./on-confirm.md) + +# onConfirm + +`val onConfirm: (`[`Choice`](../../-choice/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L20) + +A callback indicating which option was selected. + +### Property + +`onConfirm` - A callback indicating which option was selected. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/-init-.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/-init-.md new file mode 100644 index 00000000000..c00fdf9813e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [TextPrompt](index.md) / [<init>](./-init-.md) + +# <init> + +`TextPrompt(title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, inputLabel: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, inputValue: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, hasShownManyDialogs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onConfirm: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/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)`)` + +Value type that represents a request for an alert prompt to enter a message. + diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/has-shown-many-dialogs.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/has-shown-many-dialogs.md new file mode 100644 index 00000000000..de15524ce25 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/has-shown-many-dialogs.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [TextPrompt](index.md) / [hasShownManyDialogs](./has-shown-many-dialogs.md) + +# hasShownManyDialogs + +`val hasShownManyDialogs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L65) + +tells if this page has shown multiple prompts within a short period of time. + +### Property + +`hasShownManyDialogs` - tells if this page has shown multiple prompts within a short period of time. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/index.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/index.md new file mode 100644 index 00000000000..30a33dd4c73 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/index.md @@ -0,0 +1,24 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [TextPrompt](./index.md) + +# TextPrompt + +`data class TextPrompt : `[`PromptRequest`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L61) + +Value type that represents a request for an alert prompt to enter a message. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TextPrompt(title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, inputLabel: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, inputValue: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, hasShownManyDialogs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onConfirm: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/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)`)`
Value type that represents a request for an alert prompt to enter a message. | + +### Properties + +| Name | Summary | +|---|---| +| [hasShownManyDialogs](has-shown-many-dialogs.md) | `val hasShownManyDialogs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
tells if this page has shown multiple prompts within a short period of time. | +| [inputLabel](input-label.md) | `val inputLabel: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
the label of the field the user should fill. | +| [inputValue](input-value.md) | `val inputValue: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
the default value of the field. | +| [onConfirm](on-confirm.md) | `val onConfirm: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/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)
tells the web page if it should continue showing alerts or not. | +| [onDismiss](on-dismiss.md) | `val onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
callback to let the page know the user dismissed the dialog. | +| [title](title.md) | `val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
title of the dialog. | diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/input-label.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/input-label.md new file mode 100644 index 00000000000..0566051a97d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/input-label.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [TextPrompt](index.md) / [inputLabel](./input-label.md) + +# inputLabel + +`val inputLabel: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L63) + +the label of the field the user should fill. + +### Property + +`inputLabel` - the label of the field the user should fill. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/input-value.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/input-value.md new file mode 100644 index 00000000000..acdbcf9bd27 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/input-value.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [TextPrompt](index.md) / [inputValue](./input-value.md) + +# inputValue + +`val inputValue: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L64) + +the default value of the field. + +### Property + +`inputValue` - the default value of the field. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/on-confirm.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/on-confirm.md new file mode 100644 index 00000000000..58e4c542c82 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/on-confirm.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [TextPrompt](index.md) / [onConfirm](./on-confirm.md) + +# onConfirm + +`val onConfirm: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L67) + +tells the web page if it should continue showing alerts or not. + +### Property + +`onConfirm` - tells the web page if it should continue showing alerts or not. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/on-dismiss.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/on-dismiss.md new file mode 100644 index 00000000000..cfbe873e76a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/on-dismiss.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [TextPrompt](index.md) / [onDismiss](./on-dismiss.md) + +# onDismiss + +`val onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L66) + +callback to let the page know the user dismissed the dialog. + +### Property + +`onDismiss` - callback to let the page know the user dismissed the dialog. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/title.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/title.md new file mode 100644 index 00000000000..ea459efdcc8 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-text-prompt/title.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [TextPrompt](index.md) / [title](./title.md) + +# title + +`val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L62) + +title of the dialog. + +### Property + +`title` - title of the dialog. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-init-.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-init-.md new file mode 100644 index 00000000000..3da4b9d0d26 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [TimeSelection](index.md) / [<init>](./-init-.md) + +# <init> + +`TimeSelection(title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, initialDate: `[`Date`](https://developer.android.com/reference/java/util/Date.html)`, minimumDate: `[`Date`](https://developer.android.com/reference/java/util/Date.html)`?, maximumDate: `[`Date`](https://developer.android.com/reference/java/util/Date.html)`?, type: `[`Type`](-type/index.md)` = Type.DATE, onConfirm: (`[`Date`](https://developer.android.com/reference/java/util/Date.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onClear: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +Value type that represents a request for a date prompt for picking a year, month, and day. + diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-type/-d-a-t-e.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-type/-d-a-t-e.md new file mode 100644 index 00000000000..d1b7a6815fd --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-type/-d-a-t-e.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.prompt](../../../index.md) / [PromptRequest](../../index.md) / [TimeSelection](../index.md) / [Type](index.md) / [DATE](./-d-a-t-e.md) + +# DATE + +`DATE` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L90) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-type/-d-a-t-e_-a-n-d_-t-i-m-e.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-type/-d-a-t-e_-a-n-d_-t-i-m-e.md new file mode 100644 index 00000000000..e7761266a44 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-type/-d-a-t-e_-a-n-d_-t-i-m-e.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.prompt](../../../index.md) / [PromptRequest](../../index.md) / [TimeSelection](../index.md) / [Type](index.md) / [DATE_AND_TIME](./-d-a-t-e_-a-n-d_-t-i-m-e.md) + +# DATE_AND_TIME + +`DATE_AND_TIME` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L90) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-type/-t-i-m-e.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-type/-t-i-m-e.md new file mode 100644 index 00000000000..270b85f6e47 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-type/-t-i-m-e.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.prompt](../../../index.md) / [PromptRequest](../../index.md) / [TimeSelection](../index.md) / [Type](index.md) / [TIME](./-t-i-m-e.md) + +# TIME + +`TIME` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L90) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-type/index.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-type/index.md new file mode 100644 index 00000000000..1cd33784eb5 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/-type/index.md @@ -0,0 +1,13 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.prompt](../../../index.md) / [PromptRequest](../../index.md) / [TimeSelection](../index.md) / [Type](./index.md) + +# Type + +`enum class Type` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L89) + +### Enum Values + +| Name | Summary | +|---|---| +| [DATE](-d-a-t-e.md) | | +| [DATE_AND_TIME](-d-a-t-e_-a-n-d_-t-i-m-e.md) | | +| [TIME](-t-i-m-e.md) | | diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/index.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/index.md new file mode 100644 index 00000000000..70619dacb30 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/index.md @@ -0,0 +1,31 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [TimeSelection](./index.md) + +# TimeSelection + +`class TimeSelection : `[`PromptRequest`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L80) + +Value type that represents a request for a date prompt for picking a year, month, and day. + +### Types + +| Name | Summary | +|---|---| +| [Type](-type/index.md) | `enum class Type` | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TimeSelection(title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, initialDate: `[`Date`](https://developer.android.com/reference/java/util/Date.html)`, minimumDate: `[`Date`](https://developer.android.com/reference/java/util/Date.html)`?, maximumDate: `[`Date`](https://developer.android.com/reference/java/util/Date.html)`?, type: `[`Type`](-type/index.md)` = Type.DATE, onConfirm: (`[`Date`](https://developer.android.com/reference/java/util/Date.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, onClear: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
Value type that represents a request for a date prompt for picking a year, month, and day. | + +### Properties + +| Name | Summary | +|---|---| +| [initialDate](initial-date.md) | `val initialDate: `[`Date`](https://developer.android.com/reference/java/util/Date.html)
date that dialog should be set by default. | +| [maximumDate](maximum-date.md) | `val maximumDate: `[`Date`](https://developer.android.com/reference/java/util/Date.html)`?`
date allow to be selected. | +| [minimumDate](minimum-date.md) | `val minimumDate: `[`Date`](https://developer.android.com/reference/java/util/Date.html)`?`
date allow to be selected. | +| [onClear](on-clear.md) | `val onClear: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
callback that is called when the user requests the picker to be clear up. | +| [onConfirm](on-confirm.md) | `val onConfirm: (`[`Date`](https://developer.android.com/reference/java/util/Date.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
callback that is called when the date is selected. | +| [title](title.md) | `val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
of the dialog. | +| [type](type.md) | `val type: `[`Type`](-type/index.md)
indicate which [Type](-type/index.md) of selection de user wants. | diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/initial-date.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/initial-date.md new file mode 100644 index 00000000000..a1235b21639 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/initial-date.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [TimeSelection](index.md) / [initialDate](./initial-date.md) + +# initialDate + +`val initialDate: `[`Date`](https://developer.android.com/reference/java/util/Date.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L82) + +date that dialog should be set by default. + +### Property + +`initialDate` - date that dialog should be set by default. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/maximum-date.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/maximum-date.md new file mode 100644 index 00000000000..a9077ee2d9a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/maximum-date.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [TimeSelection](index.md) / [maximumDate](./maximum-date.md) + +# maximumDate + +`val maximumDate: `[`Date`](https://developer.android.com/reference/java/util/Date.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L84) + +date allow to be selected. + +### Property + +`maximumDate` - date allow to be selected. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/minimum-date.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/minimum-date.md new file mode 100644 index 00000000000..6dd190d6c90 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/minimum-date.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [TimeSelection](index.md) / [minimumDate](./minimum-date.md) + +# minimumDate + +`val minimumDate: `[`Date`](https://developer.android.com/reference/java/util/Date.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L83) + +date allow to be selected. + +### Property + +`minimumDate` - date allow to be selected. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/on-clear.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/on-clear.md new file mode 100644 index 00000000000..81471e3c065 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/on-clear.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [TimeSelection](index.md) / [onClear](./on-clear.md) + +# onClear + +`val onClear: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L87) + +callback that is called when the user requests the picker to be clear up. + +### Property + +`onClear` - callback that is called when the user requests the picker to be clear up. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/on-confirm.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/on-confirm.md new file mode 100644 index 00000000000..479a198043b --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/on-confirm.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [TimeSelection](index.md) / [onConfirm](./on-confirm.md) + +# onConfirm + +`val onConfirm: (`[`Date`](https://developer.android.com/reference/java/util/Date.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L86) + +callback that is called when the date is selected. + +### Property + +`onConfirm` - callback that is called when the date is selected. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/title.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/title.md new file mode 100644 index 00000000000..791dd8f0b01 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/title.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [TimeSelection](index.md) / [title](./title.md) + +# title + +`val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L81) + +of the dialog. + +### Property + +`title` - of the dialog. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/type.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/type.md new file mode 100644 index 00000000000..54b82dac6e6 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/-time-selection/type.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.prompt](../../index.md) / [PromptRequest](../index.md) / [TimeSelection](index.md) / [type](./type.md) + +# type + +`val type: `[`Type`](-type/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L85) + +indicate which [Type](-type/index.md) of selection de user wants. + +### Property + +`type` - indicate which [Type](-type/index.md) of selection de user wants. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/index.md b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/index.md new file mode 100644 index 00000000000..cbf410499c3 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/-prompt-request/index.md @@ -0,0 +1,39 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.prompt](../index.md) / [PromptRequest](./index.md) + +# PromptRequest + +`sealed class PromptRequest` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/prompt/PromptRequest.kt#L14) + +Value type that represents a request for showing a native dialog for prompt web content. + +### Types + +| Name | Summary | +|---|---| +| [Alert](-alert/index.md) | `data class Alert : `[`PromptRequest`](./index.md)
Value type that represents a request for an alert prompt. | +| [Authentication](-authentication/index.md) | `data class Authentication : `[`PromptRequest`](./index.md)
Value type that represents a request for an authentication prompt. For more related info take a look at <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication>MDN docs | +| [Color](-color/index.md) | `data class Color : `[`PromptRequest`](./index.md)
Value type that represents a request for a selecting one or multiple files. | +| [Confirm](-confirm/index.md) | `data class Confirm : `[`PromptRequest`](./index.md)
Value type that represents a request for showing a <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/confirm>confirm prompt. | +| [File](-file/index.md) | `data class File : `[`PromptRequest`](./index.md)
Value type that represents a request for a selecting one or multiple files. | +| [MenuChoice](-menu-choice/index.md) | `data class MenuChoice : `[`PromptRequest`](./index.md)
Value type that represents a request for a menu choice prompt. | +| [MultipleChoice](-multiple-choice/index.md) | `data class MultipleChoice : `[`PromptRequest`](./index.md)
Value type that represents a request for a multiple choice prompt. | +| [Popup](-popup/index.md) | `data class Popup : `[`PromptRequest`](./index.md)
Value type that represents a request for showing a pop-pup prompt. This occurs when content attempts to open a new window, in a way that doesn't appear to be the result of user input. | +| [SingleChoice](-single-choice/index.md) | `data class SingleChoice : `[`PromptRequest`](./index.md)
Value type that represents a request for a single choice prompt. | +| [TextPrompt](-text-prompt/index.md) | `data class TextPrompt : `[`PromptRequest`](./index.md)
Value type that represents a request for an alert prompt to enter a message. | +| [TimeSelection](-time-selection/index.md) | `class TimeSelection : `[`PromptRequest`](./index.md)
Value type that represents a request for a date prompt for picking a year, month, and day. | + +### Inheritors + +| Name | Summary | +|---|---| +| [Alert](-alert/index.md) | `data class Alert : `[`PromptRequest`](./index.md)
Value type that represents a request for an alert prompt. | +| [Authentication](-authentication/index.md) | `data class Authentication : `[`PromptRequest`](./index.md)
Value type that represents a request for an authentication prompt. For more related info take a look at <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication>MDN docs | +| [Color](-color/index.md) | `data class Color : `[`PromptRequest`](./index.md)
Value type that represents a request for a selecting one or multiple files. | +| [Confirm](-confirm/index.md) | `data class Confirm : `[`PromptRequest`](./index.md)
Value type that represents a request for showing a <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/confirm>confirm prompt. | +| [File](-file/index.md) | `data class File : `[`PromptRequest`](./index.md)
Value type that represents a request for a selecting one or multiple files. | +| [MenuChoice](-menu-choice/index.md) | `data class MenuChoice : `[`PromptRequest`](./index.md)
Value type that represents a request for a menu choice prompt. | +| [MultipleChoice](-multiple-choice/index.md) | `data class MultipleChoice : `[`PromptRequest`](./index.md)
Value type that represents a request for a multiple choice prompt. | +| [Popup](-popup/index.md) | `data class Popup : `[`PromptRequest`](./index.md)
Value type that represents a request for showing a pop-pup prompt. This occurs when content attempts to open a new window, in a way that doesn't appear to be the result of user input. | +| [SingleChoice](-single-choice/index.md) | `data class SingleChoice : `[`PromptRequest`](./index.md)
Value type that represents a request for a single choice prompt. | +| [TextPrompt](-text-prompt/index.md) | `data class TextPrompt : `[`PromptRequest`](./index.md)
Value type that represents a request for an alert prompt to enter a message. | +| [TimeSelection](-time-selection/index.md) | `class TimeSelection : `[`PromptRequest`](./index.md)
Value type that represents a request for a date prompt for picking a year, month, and day. | diff --git a/docs/api/mozilla.components.concept.engine.prompt/index.md b/docs/api/mozilla.components.concept.engine.prompt/index.md new file mode 100644 index 00000000000..a50f85d83d9 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.prompt/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.concept.engine.prompt](./index.md) + +## Package mozilla.components.concept.engine.prompt + +### Types + +| Name | Summary | +|---|---| +| [Choice](-choice/index.md) | `data class Choice : `[`Parcelable`](https://developer.android.com/reference/android/os/Parcelable.html)
Value type that represents a select option, optgroup or menuitem html element. | +| [PromptRequest](-prompt-request/index.md) | `sealed class PromptRequest`
Value type that represents a request for showing a native dialog for prompt web content. | diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/-init-.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/-init-.md new file mode 100644 index 00000000000..b05ecebb82a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.request](../../index.md) / [RequestInterceptor](../index.md) / [ErrorResponse](index.md) / [<init>](./-init-.md) + +# <init> + +`ErrorResponse(data: `[`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)`? = null, 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 error request. + diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/data.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/data.md new file mode 100644 index 00000000000..1d8751c87bc --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/data.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.request](../../index.md) / [RequestInterceptor](../index.md) / [ErrorResponse](index.md) / [data](./data.md) + +# data + +`val data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/request/RequestInterceptor.kt#L31) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/encoding.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/encoding.md new file mode 100644 index 00000000000..5de6c8f1f3d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/encoding.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.request](../../index.md) / [RequestInterceptor](../index.md) / [ErrorResponse](index.md) / [encoding](./encoding.md) + +# encoding + +`val encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/request/RequestInterceptor.kt#L34) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/index.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/index.md new file mode 100644 index 00000000000..593c29b8b13 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/index.md @@ -0,0 +1,22 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.request](../../index.md) / [RequestInterceptor](../index.md) / [ErrorResponse](./index.md) + +# ErrorResponse + +`data class ErrorResponse` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/request/RequestInterceptor.kt#L30) + +An alternative response for an error request. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ErrorResponse(data: `[`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)`? = null, 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 error request. | + +### Properties + +| Name | Summary | +|---|---| +| [data](data.md) | `val data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [encoding](encoding.md) | `val encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [mimeType](mime-type.md) | `val mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [url](url.md) | `val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/mime-type.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/mime-type.md new file mode 100644 index 00000000000..91750b2fd75 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/mime-type.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.request](../../index.md) / [RequestInterceptor](../index.md) / [ErrorResponse](index.md) / [mimeType](./mime-type.md) + +# mimeType + +`val mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/request/RequestInterceptor.kt#L33) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/url.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/url.md new file mode 100644 index 00000000000..360447c26da --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-error-response/url.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.request](../../index.md) / [RequestInterceptor](../index.md) / [ErrorResponse](index.md) / [url](./url.md) + +# url + +`val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/request/RequestInterceptor.kt#L32) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/-init-.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/-init-.md new file mode 100644 index 00000000000..b5c67693d77 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.request](../../../index.md) / [RequestInterceptor](../../index.md) / [InterceptionResponse](../index.md) / [Content](index.md) / [<init>](./-init-.md) + +# <init> + +`Content(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")` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/data.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/data.md new file mode 100644 index 00000000000..45bd6114394 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/data.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.request](../../../index.md) / [RequestInterceptor](../../index.md) / [InterceptionResponse](../index.md) / [Content](index.md) / [data](./data.md) + +# data + +`val data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/request/RequestInterceptor.kt#L19) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/encoding.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/encoding.md new file mode 100644 index 00000000000..330f28aa4ad --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/encoding.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.request](../../../index.md) / [RequestInterceptor](../../index.md) / [InterceptionResponse](../index.md) / [Content](index.md) / [encoding](./encoding.md) + +# encoding + +`val encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/request/RequestInterceptor.kt#L21) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/index.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/index.md new file mode 100644 index 00000000000..9e96e872424 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/index.md @@ -0,0 +1,19 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.request](../../../index.md) / [RequestInterceptor](../../index.md) / [InterceptionResponse](../index.md) / [Content](./index.md) + +# Content + +`data class Content : `[`InterceptionResponse`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/request/RequestInterceptor.kt#L18) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Content(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")` | + +### Properties + +| Name | Summary | +|---|---| +| [data](data.md) | `val data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [encoding](encoding.md) | `val encoding: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [mimeType](mime-type.md) | `val mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/mime-type.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/mime-type.md new file mode 100644 index 00000000000..7b1ad2bf952 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-content/mime-type.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.request](../../../index.md) / [RequestInterceptor](../../index.md) / [InterceptionResponse](../index.md) / [Content](index.md) / [mimeType](./mime-type.md) + +# mimeType + +`val mimeType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/request/RequestInterceptor.kt#L20) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-url/-init-.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-url/-init-.md new file mode 100644 index 00000000000..eea47bc3c19 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-url/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.request](../../../index.md) / [RequestInterceptor](../../index.md) / [InterceptionResponse](../index.md) / [Url](index.md) / [<init>](./-init-.md) + +# <init> + +`Url(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-url/index.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-url/index.md new file mode 100644 index 00000000000..f660de0dfa3 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-url/index.md @@ -0,0 +1,17 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.request](../../../index.md) / [RequestInterceptor](../../index.md) / [InterceptionResponse](../index.md) / [Url](./index.md) + +# Url + +`data class Url : `[`InterceptionResponse`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/request/RequestInterceptor.kt#L24) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Url(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` | + +### Properties + +| Name | Summary | +|---|---| +| [url](url.md) | `val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-url/url.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-url/url.md new file mode 100644 index 00000000000..f0e621b102d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/-url/url.md @@ -0,0 +1,5 @@ +[android-components](../../../../index.md) / [mozilla.components.concept.engine.request](../../../index.md) / [RequestInterceptor](../../index.md) / [InterceptionResponse](../index.md) / [Url](index.md) / [url](./url.md) + +# url + +`val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/request/RequestInterceptor.kt#L24) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/index.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/index.md new file mode 100644 index 00000000000..5b75a7ed2df --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/-interception-response/index.md @@ -0,0 +1,21 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine.request](../../index.md) / [RequestInterceptor](../index.md) / [InterceptionResponse](./index.md) + +# InterceptionResponse + +`sealed class InterceptionResponse` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/request/RequestInterceptor.kt#L17) + +An alternative response for an intercepted request. + +### Types + +| Name | Summary | +|---|---| +| [Content](-content/index.md) | `data class Content : `[`InterceptionResponse`](./index.md) | +| [Url](-url/index.md) | `data class Url : `[`InterceptionResponse`](./index.md) | + +### Inheritors + +| Name | Summary | +|---|---| +| [Content](-content/index.md) | `data class Content : `[`InterceptionResponse`](./index.md) | +| [Url](-url/index.md) | `data class Url : `[`InterceptionResponse`](./index.md) | diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/index.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/index.md new file mode 100644 index 00000000000..b4bd967d5a6 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/index.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.request](../index.md) / [RequestInterceptor](./index.md) + +# RequestInterceptor + +`interface RequestInterceptor` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/request/RequestInterceptor.kt#L13) + +Interface for classes that want to intercept load requests to allow custom behavior. + +### Types + +| Name | Summary | +|---|---| +| [ErrorResponse](-error-response/index.md) | `data class ErrorResponse`
An alternative response for an error request. | +| [InterceptionResponse](-interception-response/index.md) | `sealed class InterceptionResponse`
An alternative response for an intercepted request. | + +### Functions + +| Name | Summary | +|---|---| +| [onErrorRequest](on-error-request.md) | `open fun onErrorRequest(session: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`, errorType: `[`ErrorType`](../../mozilla.components.browser.errorpages/-error-type/index.md)`, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?): `[`ErrorResponse`](-error-response/index.md)`?`
A request that the engine wasn't able to handle that resulted in an error. | +| [onLoadRequest](on-load-request.md) | `open fun onLoadRequest(session: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`InterceptionResponse`](-interception-response/index.md)`?`
A request to open an URI. This is called before each page load to allow providing custom behavior. | diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/on-error-request.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/on-error-request.md new file mode 100644 index 00000000000..232f4fba31a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/on-error-request.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.request](../index.md) / [RequestInterceptor](index.md) / [onErrorRequest](./on-error-request.md) + +# onErrorRequest + +`open fun onErrorRequest(session: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`, errorType: `[`ErrorType`](../../mozilla.components.browser.errorpages/-error-type/index.md)`, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?): `[`ErrorResponse`](-error-response/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/request/RequestInterceptor.kt#L58) + +A request that the engine wasn't able to handle that resulted in an error. + +### Parameters + +`session` - The engine session that initiated the callback. + +`errorType` - The error that was provided by the engine related to the +type of error caused. + +`uri` - The uri that resulted in the error. + +**Return** +An [ErrorResponse](-error-response/index.md) object containing content to display for the +provided error type. + diff --git a/docs/api/mozilla.components.concept.engine.request/-request-interceptor/on-load-request.md b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/on-load-request.md new file mode 100644 index 00000000000..0db83ae77b7 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/-request-interceptor/on-load-request.md @@ -0,0 +1,18 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.request](../index.md) / [RequestInterceptor](index.md) / [onLoadRequest](./on-load-request.md) + +# onLoadRequest + +`open fun onLoadRequest(session: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`, uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`InterceptionResponse`](-interception-response/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/request/RequestInterceptor.kt#L46) + +A request to open an URI. This is called before each page load to allow +providing custom behavior. + +### Parameters + +`session` - The engine session that initiated the callback. + +**Return** +An [InterceptionResponse](-interception-response/index.md) object containing alternative content +or an alternative URL. Null if the original request should continue to +be loaded. + diff --git a/docs/api/mozilla.components.concept.engine.request/index.md b/docs/api/mozilla.components.concept.engine.request/index.md new file mode 100644 index 00000000000..3da10e41bb8 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.request/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.concept.engine.request](./index.md) + +## Package mozilla.components.concept.engine.request + +### Types + +| Name | Summary | +|---|---| +| [RequestInterceptor](-request-interceptor/index.md) | `interface RequestInterceptor`
Interface for classes that want to intercept load requests to allow custom behavior. | diff --git a/docs/api/mozilla.components.concept.engine.window/-window-request/index.md b/docs/api/mozilla.components.concept.engine.window/-window-request/index.md new file mode 100644 index 00000000000..ed62b503a88 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.window/-window-request/index.md @@ -0,0 +1,26 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.window](../index.md) / [WindowRequest](./index.md) + +# WindowRequest + +`interface WindowRequest` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/window/WindowRequest.kt#L12) + +Represents a request to open or close a browser window. + +### Properties + +| Name | Summary | +|---|---| +| [url](url.md) | `abstract val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The URL which should be opened in a new window. May be empty if the request was created from JavaScript (using window.open()). | + +### Functions + +| Name | Summary | +|---|---| +| [prepare](prepare.md) | `abstract fun prepare(engineSession: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Prepares the provided [EngineSession](../../mozilla.components.concept.engine/-engine-session/index.md) for the window request. This is used to attach state (e.g. a native session) to the engine session. | +| [start](start.md) | `abstract fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts the window request. | + +### Inheritors + +| Name | Summary | +|---|---| +| [SystemWindowRequest](../../mozilla.components.browser.engine.system.window/-system-window-request/index.md) | `class SystemWindowRequest : `[`WindowRequest`](./index.md)
WebView-based implementation of [WindowRequest](./index.md). | diff --git a/docs/api/mozilla.components.concept.engine.window/-window-request/prepare.md b/docs/api/mozilla.components.concept.engine.window/-window-request/prepare.md new file mode 100644 index 00000000000..fce95cadd62 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.window/-window-request/prepare.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.window](../index.md) / [WindowRequest](index.md) / [prepare](./prepare.md) + +# prepare + +`abstract fun prepare(engineSession: `[`EngineSession`](../../mozilla.components.concept.engine/-engine-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/window/WindowRequest.kt#L27) + +Prepares the provided [EngineSession](../../mozilla.components.concept.engine/-engine-session/index.md) for the window request. This +is used to attach state (e.g. a native session) to the engine session. + +### Parameters + +`engineSession` - the engine session to prepare. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine.window/-window-request/start.md b/docs/api/mozilla.components.concept.engine.window/-window-request/start.md new file mode 100644 index 00000000000..cfb560364ef --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.window/-window-request/start.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.window](../index.md) / [WindowRequest](index.md) / [start](./start.md) + +# start + +`abstract fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/window/WindowRequest.kt#L32) + +Starts the window request. + diff --git a/docs/api/mozilla.components.concept.engine.window/-window-request/url.md b/docs/api/mozilla.components.concept.engine.window/-window-request/url.md new file mode 100644 index 00000000000..c9845cc8d01 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.window/-window-request/url.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine.window](../index.md) / [WindowRequest](index.md) / [url](./url.md) + +# url + +`abstract val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/window/WindowRequest.kt#L19) + +The URL which should be opened in a new window. May be +empty if the request was created from JavaScript (using +window.open()). + diff --git a/docs/api/mozilla.components.concept.engine.window/index.md b/docs/api/mozilla.components.concept.engine.window/index.md new file mode 100644 index 00000000000..7ebd45002a9 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine.window/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.concept.engine.window](./index.md) + +## Package mozilla.components.concept.engine.window + +### Types + +| Name | Summary | +|---|---| +| [WindowRequest](-window-request/index.md) | `interface WindowRequest`
Represents a request to open or close a browser window. | diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/-init-.md b/docs/api/mozilla.components.concept.engine/-default-settings/-init-.md new file mode 100644 index 00000000000..6b3c051b15a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [<init>](./-init-.md) + +# <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, webFontsEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, mediaPlaybackRequiresUserGesture: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, trackingProtectionPolicy: `[`TrackingProtectionPolicy`](../-engine-session/-tracking-protection-policy/index.md)`? = null, requestInterceptor: `[`RequestInterceptor`](../../mozilla.components.concept.engine.request/-request-interceptor/index.md)`? = null, historyTrackingDelegate: `[`HistoryTrackingDelegate`](../../mozilla.components.concept.engine.history/-history-tracking-delegate/index.md)`? = null, userAgentString: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, javaScriptCanOpenWindowsAutomatically: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, displayZoomControls: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, loadWithOverviewMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, allowFileAccess: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, allowFileAccessFromFileURLs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, allowUniversalAccessFromFileURLs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, allowContentAccess: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, verticalScrollBarEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, horizontalScrollBarEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, remoteDebuggingEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, supportMultipleWindows: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, testingModeEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false)` + +[Settings](../-settings/index.md) implementation used to set defaults for [Engine](../-engine/index.md) and [EngineSession](../-engine-session/index.md). + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/allow-content-access.md b/docs/api/mozilla.components.concept.engine/-default-settings/allow-content-access.md new file mode 100644 index 00000000000..1c48e957a9b --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/allow-content-access.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [allowContentAccess](./allow-content-access.md) + +# allowContentAccess + +`var allowContentAccess: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L141) + +Overrides [Settings.allowContentAccess](../-settings/allow-content-access.md) + +Setting to control whether or not the engine is allowed to load content from a content +provider installed in the system. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/allow-file-access-from-file-u-r-ls.md b/docs/api/mozilla.components.concept.engine/-default-settings/allow-file-access-from-file-u-r-ls.md new file mode 100644 index 00000000000..134a7fce6b1 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/allow-file-access-from-file-u-r-ls.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [allowFileAccessFromFileURLs](./allow-file-access-from-file-u-r-ls.md) + +# allowFileAccessFromFileURLs + +`var allowFileAccessFromFileURLs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L139) + +Overrides [Settings.allowFileAccessFromFileURLs](../-settings/allow-file-access-from-file-u-r-ls.md) + +Setting to control whether or not JavaScript running in the context of a file scheme URL +should be allowed to access content from other file scheme URLs. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/allow-file-access.md b/docs/api/mozilla.components.concept.engine/-default-settings/allow-file-access.md new file mode 100644 index 00000000000..38c55f143e9 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/allow-file-access.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [allowFileAccess](./allow-file-access.md) + +# allowFileAccess + +`var allowFileAccess: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L138) + +Overrides [Settings.allowFileAccess](../-settings/allow-file-access.md) + +Setting to control whether or not file access is allowed. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/allow-universal-access-from-file-u-r-ls.md b/docs/api/mozilla.components.concept.engine/-default-settings/allow-universal-access-from-file-u-r-ls.md new file mode 100644 index 00000000000..3f1a6b31bd5 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/allow-universal-access-from-file-u-r-ls.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [allowUniversalAccessFromFileURLs](./allow-universal-access-from-file-u-r-ls.md) + +# allowUniversalAccessFromFileURLs + +`var allowUniversalAccessFromFileURLs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L140) + +Overrides [Settings.allowUniversalAccessFromFileURLs](../-settings/allow-universal-access-from-file-u-r-ls.md) + +Setting to control whether or not JavaScript running in the context of a file scheme URL +should be allowed to access content from any origin. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/display-zoom-controls.md b/docs/api/mozilla.components.concept.engine/-default-settings/display-zoom-controls.md new file mode 100644 index 00000000000..768f25b9ccb --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/display-zoom-controls.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [displayZoomControls](./display-zoom-controls.md) + +# displayZoomControls + +`var displayZoomControls: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L136) + +Overrides [Settings.displayZoomControls](../-settings/display-zoom-controls.md) + +Setting to control whether or not zoom controls should be displayed. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/dom-storage-enabled.md b/docs/api/mozilla.components.concept.engine/-default-settings/dom-storage-enabled.md new file mode 100644 index 00000000000..c22dda622ee --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/dom-storage-enabled.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [domStorageEnabled](./dom-storage-enabled.md) + +# domStorageEnabled + +`var domStorageEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L128) + +Overrides [Settings.domStorageEnabled](../-settings/dom-storage-enabled.md) + +Setting to control whether or not DOM Storage is enabled. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/history-tracking-delegate.md b/docs/api/mozilla.components.concept.engine/-default-settings/history-tracking-delegate.md new file mode 100644 index 00000000000..40e8822fc73 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/history-tracking-delegate.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [historyTrackingDelegate](./history-tracking-delegate.md) + +# historyTrackingDelegate + +`var historyTrackingDelegate: `[`HistoryTrackingDelegate`](../../mozilla.components.concept.engine.history/-history-tracking-delegate/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L133) + +Overrides [Settings.historyTrackingDelegate](../-settings/history-tracking-delegate.md) + +Setting to provide a history delegate to the engine. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/horizontal-scroll-bar-enabled.md b/docs/api/mozilla.components.concept.engine/-default-settings/horizontal-scroll-bar-enabled.md new file mode 100644 index 00000000000..600cd4aef3d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/horizontal-scroll-bar-enabled.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [horizontalScrollBarEnabled](./horizontal-scroll-bar-enabled.md) + +# horizontalScrollBarEnabled + +`var horizontalScrollBarEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L143) + +Overrides [Settings.horizontalScrollBarEnabled](../-settings/horizontal-scroll-bar-enabled.md) + +Setting to control whether or not horizontal scrolling is enabled. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/index.md b/docs/api/mozilla.components.concept.engine/-default-settings/index.md new file mode 100644 index 00000000000..224c275bdfe --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/index.md @@ -0,0 +1,38 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](./index.md) + +# DefaultSettings + +`data class DefaultSettings : `[`Settings`](../-settings/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L126) + +[Settings](../-settings/index.md) implementation used to set defaults for [Engine](../-engine/index.md) and [EngineSession](../-engine-session/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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, webFontsEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, mediaPlaybackRequiresUserGesture: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, trackingProtectionPolicy: `[`TrackingProtectionPolicy`](../-engine-session/-tracking-protection-policy/index.md)`? = null, requestInterceptor: `[`RequestInterceptor`](../../mozilla.components.concept.engine.request/-request-interceptor/index.md)`? = null, historyTrackingDelegate: `[`HistoryTrackingDelegate`](../../mozilla.components.concept.engine.history/-history-tracking-delegate/index.md)`? = null, userAgentString: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, javaScriptCanOpenWindowsAutomatically: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, displayZoomControls: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, loadWithOverviewMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, allowFileAccess: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, allowFileAccessFromFileURLs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, allowUniversalAccessFromFileURLs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, allowContentAccess: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, verticalScrollBarEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, horizontalScrollBarEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, remoteDebuggingEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, supportMultipleWindows: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, testingModeEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false)`
[Settings](../-settings/index.md) implementation used to set defaults for [Engine](../-engine/index.md) and [EngineSession](../-engine-session/index.md). | + +### Properties + +| Name | Summary | +|---|---| +| [allowContentAccess](allow-content-access.md) | `var allowContentAccess: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not the engine is allowed to load content from a content provider installed in the system. | +| [allowFileAccess](allow-file-access.md) | `var allowFileAccess: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not file access is allowed. | +| [allowFileAccessFromFileURLs](allow-file-access-from-file-u-r-ls.md) | `var allowFileAccessFromFileURLs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not JavaScript running in the context of a file scheme URL should be allowed to access content from other file scheme URLs. | +| [allowUniversalAccessFromFileURLs](allow-universal-access-from-file-u-r-ls.md) | `var allowUniversalAccessFromFileURLs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not JavaScript running in the context of a file scheme URL should be allowed to access content from any origin. | +| [displayZoomControls](display-zoom-controls.md) | `var displayZoomControls: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not zoom controls should be displayed. | +| [domStorageEnabled](dom-storage-enabled.md) | `var domStorageEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not DOM Storage is enabled. | +| [historyTrackingDelegate](history-tracking-delegate.md) | `var historyTrackingDelegate: `[`HistoryTrackingDelegate`](../../mozilla.components.concept.engine.history/-history-tracking-delegate/index.md)`?`
Setting to provide a history delegate to the engine. | +| [horizontalScrollBarEnabled](horizontal-scroll-bar-enabled.md) | `var horizontalScrollBarEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not horizontal scrolling is enabled. | +| [javaScriptCanOpenWindowsAutomatically](java-script-can-open-windows-automatically.md) | `var javaScriptCanOpenWindowsAutomatically: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not window.open can be called from JavaScript. | +| [javascriptEnabled](javascript-enabled.md) | `var javascriptEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not JavaScript is enabled. | +| [loadWithOverviewMode](load-with-overview-mode.md) | `var loadWithOverviewMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not the engine zooms out the content to fit on screen by width. | +| [mediaPlaybackRequiresUserGesture](media-playback-requires-user-gesture.md) | `var mediaPlaybackRequiresUserGesture: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not a user gesture is required to play media. | +| [remoteDebuggingEnabled](remote-debugging-enabled.md) | `var remoteDebuggingEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not remote debugging is enabled. | +| [requestInterceptor](request-interceptor.md) | `var requestInterceptor: `[`RequestInterceptor`](../../mozilla.components.concept.engine.request/-request-interceptor/index.md)`?`
Setting to intercept and override requests. | +| [supportMultipleWindows](support-multiple-windows.md) | `var supportMultipleWindows: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not multiple windows are supported. | +| [testingModeEnabled](testing-mode-enabled.md) | `var testingModeEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not testing mode is enabled. | +| [trackingProtectionPolicy](tracking-protection-policy.md) | `var trackingProtectionPolicy: `[`TrackingProtectionPolicy`](../-engine-session/-tracking-protection-policy/index.md)`?`
Setting to control tracking protection. | +| [userAgentString](user-agent-string.md) | `var userAgentString: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Setting to control the user agent string. | +| [verticalScrollBarEnabled](vertical-scroll-bar-enabled.md) | `var verticalScrollBarEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not vertical scrolling is enabled. | +| [webFontsEnabled](web-fonts-enabled.md) | `var webFontsEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not Web fonts are enabled. | diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/java-script-can-open-windows-automatically.md b/docs/api/mozilla.components.concept.engine/-default-settings/java-script-can-open-windows-automatically.md new file mode 100644 index 00000000000..6c0a002481d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/java-script-can-open-windows-automatically.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [javaScriptCanOpenWindowsAutomatically](./java-script-can-open-windows-automatically.md) + +# javaScriptCanOpenWindowsAutomatically + +`var javaScriptCanOpenWindowsAutomatically: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L135) + +Overrides [Settings.javaScriptCanOpenWindowsAutomatically](../-settings/java-script-can-open-windows-automatically.md) + +Setting to control whether or not window.open can be called from JavaScript. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/javascript-enabled.md b/docs/api/mozilla.components.concept.engine/-default-settings/javascript-enabled.md new file mode 100644 index 00000000000..d412ac9de09 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/javascript-enabled.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [javascriptEnabled](./javascript-enabled.md) + +# javascriptEnabled + +`var javascriptEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L127) + +Overrides [Settings.javascriptEnabled](../-settings/javascript-enabled.md) + +Setting to control whether or not JavaScript is enabled. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/load-with-overview-mode.md b/docs/api/mozilla.components.concept.engine/-default-settings/load-with-overview-mode.md new file mode 100644 index 00000000000..8d8473a654e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/load-with-overview-mode.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [loadWithOverviewMode](./load-with-overview-mode.md) + +# loadWithOverviewMode + +`var loadWithOverviewMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L137) + +Overrides [Settings.loadWithOverviewMode](../-settings/load-with-overview-mode.md) + +Setting to control whether or not the engine zooms out the content to fit on screen by width. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/media-playback-requires-user-gesture.md b/docs/api/mozilla.components.concept.engine/-default-settings/media-playback-requires-user-gesture.md new file mode 100644 index 00000000000..50d1c948064 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/media-playback-requires-user-gesture.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [mediaPlaybackRequiresUserGesture](./media-playback-requires-user-gesture.md) + +# mediaPlaybackRequiresUserGesture + +`var mediaPlaybackRequiresUserGesture: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L130) + +Overrides [Settings.mediaPlaybackRequiresUserGesture](../-settings/media-playback-requires-user-gesture.md) + +Setting to control whether or not a user gesture is required to play media. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/remote-debugging-enabled.md b/docs/api/mozilla.components.concept.engine/-default-settings/remote-debugging-enabled.md new file mode 100644 index 00000000000..a544cb2c788 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/remote-debugging-enabled.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [remoteDebuggingEnabled](./remote-debugging-enabled.md) + +# remoteDebuggingEnabled + +`var remoteDebuggingEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L144) + +Overrides [Settings.remoteDebuggingEnabled](../-settings/remote-debugging-enabled.md) + +Setting to control whether or not remote debugging is enabled. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/request-interceptor.md b/docs/api/mozilla.components.concept.engine/-default-settings/request-interceptor.md new file mode 100644 index 00000000000..176ade32b3a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/request-interceptor.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [requestInterceptor](./request-interceptor.md) + +# requestInterceptor + +`var requestInterceptor: `[`RequestInterceptor`](../../mozilla.components.concept.engine.request/-request-interceptor/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L132) + +Overrides [Settings.requestInterceptor](../-settings/request-interceptor.md) + +Setting to intercept and override requests. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/support-multiple-windows.md b/docs/api/mozilla.components.concept.engine/-default-settings/support-multiple-windows.md new file mode 100644 index 00000000000..fdb8f70886e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/support-multiple-windows.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [supportMultipleWindows](./support-multiple-windows.md) + +# supportMultipleWindows + +`var supportMultipleWindows: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L145) + +Overrides [Settings.supportMultipleWindows](../-settings/support-multiple-windows.md) + +Setting to control whether or not multiple windows are supported. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/testing-mode-enabled.md b/docs/api/mozilla.components.concept.engine/-default-settings/testing-mode-enabled.md new file mode 100644 index 00000000000..63a70082c98 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/testing-mode-enabled.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [testingModeEnabled](./testing-mode-enabled.md) + +# testingModeEnabled + +`var testingModeEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L146) + +Overrides [Settings.testingModeEnabled](../-settings/testing-mode-enabled.md) + +Setting to control whether or not testing mode is enabled. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/tracking-protection-policy.md b/docs/api/mozilla.components.concept.engine/-default-settings/tracking-protection-policy.md new file mode 100644 index 00000000000..26f1764a08d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/tracking-protection-policy.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [trackingProtectionPolicy](./tracking-protection-policy.md) + +# trackingProtectionPolicy + +`var trackingProtectionPolicy: `[`TrackingProtectionPolicy`](../-engine-session/-tracking-protection-policy/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L131) + +Overrides [Settings.trackingProtectionPolicy](../-settings/tracking-protection-policy.md) + +Setting to control tracking protection. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/user-agent-string.md b/docs/api/mozilla.components.concept.engine/-default-settings/user-agent-string.md new file mode 100644 index 00000000000..e76307376ac --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/user-agent-string.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [userAgentString](./user-agent-string.md) + +# userAgentString + +`var userAgentString: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L134) + +Overrides [Settings.userAgentString](../-settings/user-agent-string.md) + +Setting to control the user agent string. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/vertical-scroll-bar-enabled.md b/docs/api/mozilla.components.concept.engine/-default-settings/vertical-scroll-bar-enabled.md new file mode 100644 index 00000000000..089ca32738a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/vertical-scroll-bar-enabled.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [verticalScrollBarEnabled](./vertical-scroll-bar-enabled.md) + +# verticalScrollBarEnabled + +`var verticalScrollBarEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L142) + +Overrides [Settings.verticalScrollBarEnabled](../-settings/vertical-scroll-bar-enabled.md) + +Setting to control whether or not vertical scrolling is enabled. + diff --git a/docs/api/mozilla.components.concept.engine/-default-settings/web-fonts-enabled.md b/docs/api/mozilla.components.concept.engine/-default-settings/web-fonts-enabled.md new file mode 100644 index 00000000000..346fd9edb79 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-default-settings/web-fonts-enabled.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [DefaultSettings](index.md) / [webFontsEnabled](./web-fonts-enabled.md) + +# webFontsEnabled + +`var webFontsEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L129) + +Overrides [Settings.webFontsEnabled](../-settings/web-fonts-enabled.md) + +Setting to control whether or not Web fonts are enabled. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session-state/index.md b/docs/api/mozilla.components.concept.engine/-engine-session-state/index.md new file mode 100644 index 00000000000..49c8da20fb1 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session-state/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSessionState](./index.md) + +# EngineSessionState + +`interface EngineSessionState` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSessionState.kt#L14) + +The state of an [EngineSession](../-engine-session/index.md). An instance can be obtained from [EngineSession.saveState](../-engine-session/save-state.md). Creating a new +[EngineSession](../-engine-session/index.md) and calling [EngineSession.restoreState](../-engine-session/restore-state.md) with the same state instance should restore the previous +session. + +### Functions + +| Name | Summary | +|---|---| +| [toJSON](to-j-s-o-n.md) | `abstract fun toJSON(): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)
Create a JSON representation of this state that can be saved to disk. | + +### Inheritors + +| Name | Summary | +|---|---| +| [GeckoEngineSessionState](../../mozilla.components.browser.engine.gecko/-gecko-engine-session-state/index.md) | `class GeckoEngineSessionState : `[`EngineSessionState`](./index.md) | +| [ServoEngineSessionState](../../mozilla.components.browser.engine.servo/-servo-engine-session-state/index.md) | `class ServoEngineSessionState : `[`EngineSessionState`](./index.md)
No-op implementation of [EngineSessionState](./index.md). | +| [SystemEngineSessionState](../../mozilla.components.browser.engine.system/-system-engine-session-state/index.md) | `class SystemEngineSessionState : `[`EngineSessionState`](./index.md) | diff --git a/docs/api/mozilla.components.concept.engine/-engine-session-state/to-j-s-o-n.md b/docs/api/mozilla.components.concept.engine/-engine-session-state/to-j-s-o-n.md new file mode 100644 index 00000000000..d5d5e7255ed --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session-state/to-j-s-o-n.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSessionState](index.md) / [toJSON](./to-j-s-o-n.md) + +# toJSON + +`abstract fun toJSON(): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSessionState.kt#L21) + +Create a JSON representation of this state that can be saved to disk. + +When reading JSON from disk [Engine.createSessionState](../-engine/create-session-state.md) can be used to turn it back into an [EngineSessionState](index.md) +instance. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-init-.md b/docs/api/mozilla.components.concept.engine/-engine-session/-init-.md new file mode 100644 index 00000000000..59a860d6258 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-init-.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [<init>](./-init-.md) + +# <init> + +`EngineSession(delegate: `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](-observer/index.md)`> = ObserverRegistry())` + +Class representing a single engine session. + +In browsers usually a session corresponds to a tab. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/index.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/index.md new file mode 100644 index 00000000000..9239f87db6d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/index.md @@ -0,0 +1,33 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](./index.md) + +# Observer + +`interface Observer` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L28) + +Interface to be implemented by classes that want to observe this engine session. + +### Functions + +| Name | Summary | +|---|---| +| [onAppPermissionRequest](on-app-permission-request.md) | `open fun onAppPermissionRequest(permissionRequest: `[`PermissionRequest`](../../../mozilla.components.concept.engine.permission/-permission-request/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onCancelContentPermissionRequest](on-cancel-content-permission-request.md) | `open fun onCancelContentPermissionRequest(permissionRequest: `[`PermissionRequest`](../../../mozilla.components.concept.engine.permission/-permission-request/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onCloseWindowRequest](on-close-window-request.md) | `open fun onCloseWindowRequest(windowRequest: `[`WindowRequest`](../../../mozilla.components.concept.engine.window/-window-request/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onContentPermissionRequest](on-content-permission-request.md) | `open fun onContentPermissionRequest(permissionRequest: `[`PermissionRequest`](../../../mozilla.components.concept.engine.permission/-permission-request/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onDesktopModeChange](on-desktop-mode-change.md) | `open fun onDesktopModeChange(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.md) | `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)`, 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.md) | `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.md) | `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) | +| [onFullScreenChange](on-full-screen-change.md) | `open fun onFullScreenChange(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) | +| [onLoadingStateChange](on-loading-state-change.md) | `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.md) | `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.md) | `open fun onLongPress(hitResult: `[`HitResult`](../../-hit-result/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onNavigationStateChange](on-navigation-state-change.md) | `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) | +| [onOpenWindowRequest](on-open-window-request.md) | `open fun onOpenWindowRequest(windowRequest: `[`WindowRequest`](../../../mozilla.components.concept.engine.window/-window-request/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onProgress](on-progress.md) | `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) | +| [onPromptRequest](on-prompt-request.md) | `open fun onPromptRequest(promptRequest: `[`PromptRequest`](../../../mozilla.components.concept.engine.prompt/-prompt-request/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onSecurityChange](on-security-change.md) | `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) | +| [onThumbnailChange](on-thumbnail-change.md) | `open fun onThumbnailChange(bitmap: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onTitleChange](on-title-change.md) | `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.md) | `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.md) | `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/mozilla.components.concept.engine/-engine-session/-observer/on-app-permission-request.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-app-permission-request.md new file mode 100644 index 00000000000..9a240e7b472 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-app-permission-request.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onAppPermissionRequest](./on-app-permission-request.md) + +# onAppPermissionRequest + +`open fun onAppPermissionRequest(permissionRequest: `[`PermissionRequest`](../../../mozilla.components.concept.engine.permission/-permission-request/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L43) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-cancel-content-permission-request.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-cancel-content-permission-request.md new file mode 100644 index 00000000000..fa582bd7291 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-cancel-content-permission-request.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onCancelContentPermissionRequest](./on-cancel-content-permission-request.md) + +# onCancelContentPermissionRequest + +`open fun onCancelContentPermissionRequest(permissionRequest: `[`PermissionRequest`](../../../mozilla.components.concept.engine.permission/-permission-request/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L45) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-close-window-request.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-close-window-request.md new file mode 100644 index 00000000000..8d280df843c --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-close-window-request.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onCloseWindowRequest](./on-close-window-request.md) + +# onCloseWindowRequest + +`open fun onCloseWindowRequest(windowRequest: `[`WindowRequest`](../../../mozilla.components.concept.engine.window/-window-request/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L48) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-content-permission-request.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-content-permission-request.md new file mode 100644 index 00000000000..33320d66dcc --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-content-permission-request.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onContentPermissionRequest](./on-content-permission-request.md) + +# onContentPermissionRequest + +`open fun onContentPermissionRequest(permissionRequest: `[`PermissionRequest`](../../../mozilla.components.concept.engine.permission/-permission-request/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L44) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-desktop-mode-change.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-desktop-mode-change.md new file mode 100644 index 00000000000..92b0eb55b32 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-desktop-mode-change.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onDesktopModeChange](./on-desktop-mode-change.md) + +# onDesktopModeChange + +`open fun onDesktopModeChange(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L38) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-external-resource.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-external-resource.md new file mode 100644 index 00000000000..5ed999e22e1 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-external-resource.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onExternalResource](./on-external-resource.md) + +# 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)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L51) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-find-result.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-find-result.md new file mode 100644 index 00000000000..acb6bfec5db --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-find-result.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onFindResult](./on-find-result.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L40) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-find.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-find.md new file mode 100644 index 00000000000..e85d58865ea --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-find.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onFind](./on-find.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L39) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-full-screen-change.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-full-screen-change.md new file mode 100644 index 00000000000..ea8bf7a2edb --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-full-screen-change.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onFullScreenChange](./on-full-screen-change.md) + +# onFullScreenChange + +`open fun onFullScreenChange(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L41) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-loading-state-change.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-loading-state-change.md new file mode 100644 index 00000000000..e5990d57dd3 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-loading-state-change.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onLoadingStateChange](./on-loading-state-change.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L32) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-location-change.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-location-change.md new file mode 100644 index 00000000000..cd35b2b8249 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-location-change.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onLocationChange](./on-location-change.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L29) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-long-press.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-long-press.md new file mode 100644 index 00000000000..cffb585f548 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-long-press.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onLongPress](./on-long-press.md) + +# onLongPress + +`open fun onLongPress(hitResult: `[`HitResult`](../../-hit-result/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L37) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-navigation-state-change.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-navigation-state-change.md new file mode 100644 index 00000000000..881e42e976b --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-navigation-state-change.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onNavigationStateChange](./on-navigation-state-change.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L33) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-open-window-request.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-open-window-request.md new file mode 100644 index 00000000000..cae628cdc07 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-open-window-request.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onOpenWindowRequest](./on-open-window-request.md) + +# onOpenWindowRequest + +`open fun onOpenWindowRequest(windowRequest: `[`WindowRequest`](../../../mozilla.components.concept.engine.window/-window-request/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L47) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-progress.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-progress.md new file mode 100644 index 00000000000..76bba7ccc09 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-progress.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onProgress](./on-progress.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L31) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-prompt-request.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-prompt-request.md new file mode 100644 index 00000000000..b7941e3fdac --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-prompt-request.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onPromptRequest](./on-prompt-request.md) + +# onPromptRequest + +`open fun onPromptRequest(promptRequest: `[`PromptRequest`](../../../mozilla.components.concept.engine.prompt/-prompt-request/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L46) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-security-change.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-security-change.md new file mode 100644 index 00000000000..b0b2e771dc0 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-security-change.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onSecurityChange](./on-security-change.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L34) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-thumbnail-change.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-thumbnail-change.md new file mode 100644 index 00000000000..e473216a9af --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-thumbnail-change.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onThumbnailChange](./on-thumbnail-change.md) + +# onThumbnailChange + +`open fun onThumbnailChange(bitmap: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L42) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-title-change.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-title-change.md new file mode 100644 index 00000000000..7e4719a2f12 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-title-change.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onTitleChange](./on-title-change.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L30) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-tracker-blocked.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-tracker-blocked.md new file mode 100644 index 00000000000..1b367a9f2f2 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-tracker-blocked.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onTrackerBlocked](./on-tracker-blocked.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L36) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-tracker-blocking-enabled-change.md b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-tracker-blocking-enabled-change.md new file mode 100644 index 00000000000..2268aa8f4d3 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-observer/on-tracker-blocking-enabled-change.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [Observer](index.md) / [onTrackerBlockingEnabledChange](./on-tracker-blocking-enabled-change.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L35) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy-for-session-types/for-private-sessions-only.md b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy-for-session-types/for-private-sessions-only.md new file mode 100644 index 00000000000..1ea79f9018c --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy-for-session-types/for-private-sessions-only.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicyForSessionTypes](index.md) / [forPrivateSessionsOnly](./for-private-sessions-only.md) + +# forPrivateSessionsOnly + +`fun forPrivateSessionsOnly(): `[`TrackingProtectionPolicy`](../-tracking-protection-policy/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L118) + +Marks this policy to be used for private sessions only. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy-for-session-types/for-regular-sessions-only.md b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy-for-session-types/for-regular-sessions-only.md new file mode 100644 index 00000000000..a856b7f0e04 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy-for-session-types/for-regular-sessions-only.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicyForSessionTypes](index.md) / [forRegularSessionsOnly](./for-regular-sessions-only.md) + +# forRegularSessionsOnly + +`fun forRegularSessionsOnly(): `[`TrackingProtectionPolicy`](../-tracking-protection-policy/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L127) + +Marks this policy to be used for regular (non-private) sessions only. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy-for-session-types/index.md b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy-for-session-types/index.md new file mode 100644 index 00000000000..1e9950e2068 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy-for-session-types/index.md @@ -0,0 +1,31 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicyForSessionTypes](./index.md) + +# TrackingProtectionPolicyForSessionTypes + +`class TrackingProtectionPolicyForSessionTypes : `[`TrackingProtectionPolicy`](../-tracking-protection-policy/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L112) + +Subtype of [TrackingProtectionPolicy](../-tracking-protection-policy/index.md) to control the type of session this policy +should be applied to. By default, a policy will be applied to all sessions. + +### Inherited Properties + +| Name | Summary | +|---|---| +| [categories](../-tracking-protection-policy/categories.md) | `val categories: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [useForPrivateSessions](../-tracking-protection-policy/use-for-private-sessions.md) | `var useForPrivateSessions: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [useForRegularSessions](../-tracking-protection-policy/use-for-regular-sessions.md) | `var useForRegularSessions: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [forPrivateSessionsOnly](for-private-sessions-only.md) | `fun forPrivateSessionsOnly(): `[`TrackingProtectionPolicy`](../-tracking-protection-policy/index.md)
Marks this policy to be used for private sessions only. | +| [forRegularSessionsOnly](for-regular-sessions-only.md) | `fun forRegularSessionsOnly(): `[`TrackingProtectionPolicy`](../-tracking-protection-policy/index.md)
Marks this policy to be used for regular (non-private) sessions only. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [contains](../-tracking-protection-policy/contains.md) | `fun contains(category: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [equals](../-tracking-protection-policy/equals.md) | `open 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](../-tracking-protection-policy/hash-code.md) | `open fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-a-d.md b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-a-d.md new file mode 100644 index 00000000000..00f968876f7 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-a-d.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicy](index.md) / [AD](./-a-d.md) + +# AD + +`const val AD: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L79) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-a-n-a-l-y-t-i-c-s.md b/docs/api/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..09e9cfa3826 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-a-n-a-l-y-t-i-c-s.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicy](index.md) / [ANALYTICS](./-a-n-a-l-y-t-i-c-s.md) + +# ANALYTICS + +`const val ANALYTICS: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L80) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-c-o-n-t-e-n-t.md b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-c-o-n-t-e-n-t.md new file mode 100644 index 00000000000..280269cc708 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-c-o-n-t-e-n-t.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicy](index.md) / [CONTENT](./-c-o-n-t-e-n-t.md) + +# CONTENT + +`const val CONTENT: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L82) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-s-o-c-i-a-l.md b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-s-o-c-i-a-l.md new file mode 100644 index 00000000000..203e87ce591 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-s-o-c-i-a-l.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicy](index.md) / [SOCIAL](./-s-o-c-i-a-l.md) + +# SOCIAL + +`const val SOCIAL: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L81) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-t-e-s-t.md b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-t-e-s-t.md new file mode 100644 index 00000000000..40877b0065a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/-t-e-s-t.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicy](index.md) / [TEST](./-t-e-s-t.md) + +# TEST + +`const val TEST: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L84) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/all.md b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/all.md new file mode 100644 index 00000000000..f1ce8159f28 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/all.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicy](index.md) / [all](./all.md) + +# all + +`fun all(): `[`TrackingProtectionPolicyForSessionTypes`](../-tracking-protection-policy-for-session-types/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L88) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/categories.md b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/categories.md new file mode 100644 index 00000000000..e18bf769d1c --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/categories.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicy](index.md) / [categories](./categories.md) + +# categories + +`val categories: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L73) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/contains.md b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/contains.md new file mode 100644 index 00000000000..c826a0d14b4 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/contains.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicy](index.md) / [contains](./contains.md) + +# contains + +`fun contains(category: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L92) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/equals.md b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/equals.md new file mode 100644 index 00000000000..1f8a1ca6f3d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/equals.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicy](index.md) / [equals](./equals.md) + +# equals + +`open 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L94) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/hash-code.md b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/hash-code.md new file mode 100644 index 00000000000..0072e520101 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/hash-code.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicy](index.md) / [hashCode](./hash-code.md) + +# hashCode + +`open fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L103) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/index.md b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/index.md new file mode 100644 index 00000000000..1f54729c2eb --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/index.md @@ -0,0 +1,50 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicy](./index.md) + +# TrackingProtectionPolicy + +`open class TrackingProtectionPolicy` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L72) + +Represents a tracking protection policy, which is a combination of +tracker categories that should be blocked. Unless otherwise specified, +a [TrackingProtectionPolicy](./index.md) is applicable to all session types (see +[TrackingProtectionPolicyForSessionTypes](../-tracking-protection-policy-for-session-types/index.md)). + +### Properties + +| Name | Summary | +|---|---| +| [categories](categories.md) | `val categories: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [useForPrivateSessions](use-for-private-sessions.md) | `var useForPrivateSessions: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [useForRegularSessions](use-for-regular-sessions.md) | `var useForRegularSessions: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [contains](contains.md) | `fun contains(category: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [equals](equals.md) | `open 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.md) | `open fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +### Companion Object Properties + +| Name | Summary | +|---|---| +| [AD](-a-d.md) | `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.md) | `const val ANALYTICS: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [CONTENT](-c-o-n-t-e-n-t.md) | `const val CONTENT: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [SOCIAL](-s-o-c-i-a-l.md) | `const val SOCIAL: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [TEST](-t-e-s-t.md) | `const val TEST: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [all](all.md) | `fun all(): `[`TrackingProtectionPolicyForSessionTypes`](../-tracking-protection-policy-for-session-types/index.md) | +| [none](none.md) | `fun none(): `[`TrackingProtectionPolicy`](./index.md) | +| [select](select.md) | `fun select(vararg categories: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TrackingProtectionPolicyForSessionTypes`](../-tracking-protection-policy-for-session-types/index.md) | + +### Inheritors + +| Name | Summary | +|---|---| +| [TrackingProtectionPolicyForSessionTypes](../-tracking-protection-policy-for-session-types/index.md) | `class TrackingProtectionPolicyForSessionTypes : `[`TrackingProtectionPolicy`](./index.md)
Subtype of [TrackingProtectionPolicy](./index.md) to control the type of session this policy should be applied to. By default, a policy will be applied to all sessions. | diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/none.md b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/none.md new file mode 100644 index 00000000000..1cb57670ab2 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/none.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicy](index.md) / [none](./none.md) + +# none + +`fun none(): `[`TrackingProtectionPolicy`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L87) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/select.md b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/select.md new file mode 100644 index 00000000000..300905dc424 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/select.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicy](index.md) / [select](./select.md) + +# select + +`fun select(vararg categories: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TrackingProtectionPolicyForSessionTypes`](../-tracking-protection-policy-for-session-types/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L89) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/use-for-private-sessions.md b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/use-for-private-sessions.md new file mode 100644 index 00000000000..3d93a100e9e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/use-for-private-sessions.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicy](index.md) / [useForPrivateSessions](./use-for-private-sessions.md) + +# useForPrivateSessions + +`var useForPrivateSessions: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L74) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/use-for-regular-sessions.md b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/use-for-regular-sessions.md new file mode 100644 index 00000000000..5b500666252 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/-tracking-protection-policy/use-for-regular-sessions.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [EngineSession](../index.md) / [TrackingProtectionPolicy](index.md) / [useForRegularSessions](./use-for-regular-sessions.md) + +# useForRegularSessions + +`var useForRegularSessions: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L75) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/capture-thumbnail.md b/docs/api/mozilla.components.concept.engine/-engine-session/capture-thumbnail.md new file mode 100644 index 00000000000..3dbeb8d715a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/capture-thumbnail.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [captureThumbnail](./capture-thumbnail.md) + +# captureThumbnail + +`abstract fun captureThumbnail(): `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L245) + +Takes a screenshot of the actual tab + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/clear-data.md b/docs/api/mozilla.components.concept.engine/-engine-session/clear-data.md new file mode 100644 index 00000000000..1fa36a6ee1e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/clear-data.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [clearData](./clear-data.md) + +# clearData + +`abstract fun clearData(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L215) + +Clears all user data sources available. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/clear-find-matches.md b/docs/api/mozilla.components.concept.engine/-engine-session/clear-find-matches.md new file mode 100644 index 00000000000..557f927350c --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/clear-find-matches.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [clearFindMatches](./clear-find-matches.md) + +# clearFindMatches + +`abstract fun clearFindMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L235) + +Clears the highlighted results of previous calls to [findAll](find-all.md) / [findNext](find-next.md). + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/close.md b/docs/api/mozilla.components.concept.engine/-engine-session/close.md new file mode 100644 index 00000000000..9137ee4d1ac --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/close.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [close](./close.md) + +# close + +`@CallSuper open fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L252) + +Close the session. This may free underlying objects. Call this when you are finished using +this session. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/disable-tracking-protection.md b/docs/api/mozilla.components.concept.engine/-engine-session/disable-tracking-protection.md new file mode 100644 index 00000000000..cccb6886272 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/disable-tracking-protection.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [disableTrackingProtection](./disable-tracking-protection.md) + +# disableTrackingProtection + +`abstract fun disableTrackingProtection(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L205) + +Disables tracking protection for this engine session. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/enable-tracking-protection.md b/docs/api/mozilla.components.concept.engine/-engine-session/enable-tracking-protection.md new file mode 100644 index 00000000000..243c62f7ac1 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/enable-tracking-protection.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [enableTrackingProtection](./enable-tracking-protection.md) + +# enableTrackingProtection + +`abstract fun enableTrackingProtection(policy: `[`TrackingProtectionPolicy`](-tracking-protection-policy/index.md)` = TrackingProtectionPolicy.all()): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L200) + +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/mozilla.components.concept.engine/-engine-session/exit-full-screen-mode.md b/docs/api/mozilla.components.concept.engine/-engine-session/exit-full-screen-mode.md new file mode 100644 index 00000000000..c31495306a6 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/exit-full-screen-mode.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [exitFullScreenMode](./exit-full-screen-mode.md) + +# exitFullScreenMode + +`abstract fun exitFullScreenMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L240) + +Exits fullscreen mode if currently in it that state. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/find-all.md b/docs/api/mozilla.components.concept.engine/-engine-session/find-all.md new file mode 100644 index 00000000000..61193036630 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/find-all.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [findAll](./find-all.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L222) + +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/mozilla.components.concept.engine/-engine-session/find-next.md b/docs/api/mozilla.components.concept.engine/-engine-session/find-next.md new file mode 100644 index 00000000000..69381dc8b00 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/find-next.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [findNext](./find-next.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L230) + +Finds and highlights the next or previous match found by [findAll](find-all.md). + +### 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/mozilla.components.concept.engine/-engine-session/go-back.md b/docs/api/mozilla.components.concept.engine/-engine-session/go-back.md new file mode 100644 index 00000000000..93f3f6d3bac --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/go-back.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [goBack](./go-back.md) + +# goBack + +`abstract fun goBack(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L171) + +Navigates back in the history of this session. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/go-forward.md b/docs/api/mozilla.components.concept.engine/-engine-session/go-forward.md new file mode 100644 index 00000000000..e69ccb43415 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/go-forward.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [goForward](./go-forward.md) + +# goForward + +`abstract fun goForward(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L176) + +Navigates forward in the history of this session. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/index.md b/docs/api/mozilla.components.concept.engine/-engine-session/index.md new file mode 100644 index 00000000000..4534b9e19ef --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/index.md @@ -0,0 +1,60 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](./index.md) + +# EngineSession + +`abstract class EngineSession : `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](-observer/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L22) + +Class representing a single engine session. + +In browsers usually a session corresponds to a tab. + +### Types + +| Name | Summary | +|---|---| +| [Observer](-observer/index.md) | `interface Observer`
Interface to be implemented by classes that want to observe this engine session. | +| [TrackingProtectionPolicy](-tracking-protection-policy/index.md) | `open class TrackingProtectionPolicy`
Represents a tracking protection policy, which is a combination of tracker categories that should be blocked. Unless otherwise specified, a [TrackingProtectionPolicy](-tracking-protection-policy/index.md) is applicable to all session types (see [TrackingProtectionPolicyForSessionTypes](-tracking-protection-policy-for-session-types/index.md)). | +| [TrackingProtectionPolicyForSessionTypes](-tracking-protection-policy-for-session-types/index.md) | `class TrackingProtectionPolicyForSessionTypes : `[`TrackingProtectionPolicy`](-tracking-protection-policy/index.md)
Subtype of [TrackingProtectionPolicy](-tracking-protection-policy/index.md) to control the type of session this policy should be applied to. By default, a policy will be applied to all sessions. | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `EngineSession(delegate: `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](-observer/index.md)`> = ObserverRegistry())`
Class representing a single engine session. | + +### Properties + +| Name | Summary | +|---|---| +| [settings](settings.md) | `abstract val settings: `[`Settings`](../-settings/index.md)
Provides access to the settings of this engine session. | + +### Functions + +| Name | Summary | +|---|---| +| [captureThumbnail](capture-thumbnail.md) | `abstract fun captureThumbnail(): `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`?`
Takes a screenshot of the actual tab | +| [clearData](clear-data.md) | `abstract fun clearData(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Clears all user data sources available. | +| [clearFindMatches](clear-find-matches.md) | `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.md) / [findNext](find-next.md). | +| [close](close.md) | `open 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.md) | `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.md) | `abstract fun enableTrackingProtection(policy: `[`TrackingProtectionPolicy`](-tracking-protection-policy/index.md)` = TrackingProtectionPolicy.all()): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Enables tracking protection for this engine session. | +| [exitFullScreenMode](exit-full-screen-mode.md) | `abstract fun exitFullScreenMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Exits fullscreen mode if currently in it that state. | +| [findAll](find-all.md) | `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.md) | `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.md). | +| [goBack](go-back.md) | `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.md) | `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.md) | `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.md) | `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.md) | `abstract fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Reloads the current URL. | +| [restoreState](restore-state.md) | `abstract fun restoreState(state: `[`EngineSessionState`](../-engine-session-state/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Restores the engine state as provided by [saveState](save-state.md). | +| [saveState](save-state.md) | `abstract fun saveState(): `[`EngineSessionState`](../-engine-session-state/index.md)
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.md) and the specific engine implementation for details. | +| [stopLoading](stop-loading.md) | `abstract fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stops loading the current session. | +| [toggleDesktopMode](toggle-desktop-mode.md) | `abstract fun toggleDesktopMode(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. | + +### Inheritors + +| Name | Summary | +|---|---| +| [GeckoEngineSession](../../mozilla.components.browser.engine.gecko/-gecko-engine-session/index.md) | `class GeckoEngineSession : CoroutineScope, `[`EngineSession`](./index.md)
Gecko-based EngineSession implementation. | +| [ServoEngineSession](../../mozilla.components.browser.engine.servo/-servo-engine-session/index.md) | `class ServoEngineSession : `[`EngineSession`](./index.md)
Servo-based EngineSession implementation. | +| [SystemEngineSession](../../mozilla.components.browser.engine.system/-system-engine-session/index.md) | `class SystemEngineSession : `[`EngineSession`](./index.md)
WebView-based EngineSession implementation. | diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/load-data.md b/docs/api/mozilla.components.concept.engine/-engine-session/load-data.md new file mode 100644 index 00000000000..0972ddf146b --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/load-data.md @@ -0,0 +1,27 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [loadData](./load-data.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L156) + +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/mozilla.components.concept.engine/-engine-session/load-url.md b/docs/api/mozilla.components.concept.engine/-engine-session/load-url.md new file mode 100644 index 00000000000..57ea272b00b --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/load-url.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [loadUrl](./load-url.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L137) + +Loads the given URL. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/reload.md b/docs/api/mozilla.components.concept.engine/-engine-session/reload.md new file mode 100644 index 00000000000..0e553741db9 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/reload.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [reload](./reload.md) + +# reload + +`abstract fun reload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L166) + +Reloads the current URL. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/restore-state.md b/docs/api/mozilla.components.concept.engine/-engine-session/restore-state.md new file mode 100644 index 00000000000..053c59fd972 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/restore-state.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [restoreState](./restore-state.md) + +# restoreState + +`abstract fun restoreState(state: `[`EngineSessionState`](../-engine-session-state/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L193) + +Restores the engine state as provided by [saveState](save-state.md). + +### Parameters + +`state` - state retrieved from [saveState](save-state.md) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/save-state.md b/docs/api/mozilla.components.concept.engine/-engine-session/save-state.md new file mode 100644 index 00000000000..a3f7e08843f --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/save-state.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [saveState](./save-state.md) + +# saveState + +`abstract fun saveState(): `[`EngineSessionState`](../-engine-session-state/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L186) + +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.md) and the specific +engine implementation for details. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/settings.md b/docs/api/mozilla.components.concept.engine/-engine-session/settings.md new file mode 100644 index 00000000000..d55101c7204 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/settings.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [settings](./settings.md) + +# settings + +`abstract val settings: `[`Settings`](../-settings/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L64) + +Provides access to the settings of this engine session. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/stop-loading.md b/docs/api/mozilla.components.concept.engine/-engine-session/stop-loading.md new file mode 100644 index 00000000000..cb3c9890cb3 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/stop-loading.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [stopLoading](./stop-loading.md) + +# stopLoading + +`abstract fun stopLoading(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L161) + +Stops loading the current session. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-session/toggle-desktop-mode.md b/docs/api/mozilla.components.concept.engine/-engine-session/toggle-desktop-mode.md new file mode 100644 index 00000000000..4e8b3f4cf86 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-session/toggle-desktop-mode.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineSession](index.md) / [toggleDesktopMode](./toggle-desktop-mode.md) + +# toggleDesktopMode + +`abstract fun toggleDesktopMode(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt#L210) + +Enables/disables Desktop Mode with an optional ability to reload the session right after. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-view/as-view.md b/docs/api/mozilla.components.concept.engine/-engine-view/as-view.md new file mode 100644 index 00000000000..1612114275f --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-view/as-view.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineView](index.md) / [asView](./as-view.md) + +# asView + +`open fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L20) + +Convenience method to cast the implementation of this interface to an Android View object. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-view/can-scroll-vertically-down.md b/docs/api/mozilla.components.concept.engine/-engine-view/can-scroll-vertically-down.md new file mode 100644 index 00000000000..3392ce41649 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-view/can-scroll-vertically-down.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineView](index.md) / [canScrollVerticallyDown](./can-scroll-vertically-down.md) + +# canScrollVerticallyDown + +`open fun canScrollVerticallyDown(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L67) + +Check if [EngineView](index.md) can be scrolled vertically down. +true if can and false otherwise. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-view/index.md b/docs/api/mozilla.components.concept.engine/-engine-view/index.md new file mode 100644 index 00000000000..5cf2a1afe97 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-view/index.md @@ -0,0 +1,29 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineView](./index.md) + +# EngineView + +`interface EngineView` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L15) + +View component that renders web content. + +### Functions + +| Name | Summary | +|---|---| +| [asView](as-view.md) | `open fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html)
Convenience method to cast the implementation of this interface to an Android View object. | +| [canScrollVerticallyDown](can-scroll-vertically-down.md) | `open fun canScrollVerticallyDown(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Check if [EngineView](./index.md) can be scrolled vertically down. true if can and false otherwise. | +| [onCreate](on-create.md) | `open fun onCreate(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_CREATE](#). See [EngineView](./index.md) implementations for details. | +| [onDestroy](on-destroy.md) | `open fun onDestroy(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_DESTROY](#). See [EngineView](./index.md) implementations for details. | +| [onPause](on-pause.md) | `open fun onPause(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_PAUSE](#). See [EngineView](./index.md) implementations for details. | +| [onResume](on-resume.md) | `open fun onResume(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_RESUME](#). See [EngineView](./index.md) implementations for details. | +| [onStart](on-start.md) | `open fun onStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_START](#). See [EngineView](./index.md) implementations for details. | +| [onStop](on-stop.md) | `open fun onStop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
To be called in response to [Lifecycle.Event.ON_STOP](#). See [EngineView](./index.md) implementations for details. | +| [render](render.md) | `abstract fun render(session: `[`EngineSession`](../-engine-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Render the content of the given session. | + +### Inheritors + +| Name | Summary | +|---|---| +| [GeckoEngineView](../../mozilla.components.browser.engine.gecko/-gecko-engine-view/index.md) | `class GeckoEngineView : `[`FrameLayout`](https://developer.android.com/reference/android/widget/FrameLayout.html)`, `[`EngineView`](./index.md)
Gecko-based EngineView implementation. | +| [ServoEngineView](../../mozilla.components.browser.engine.servo/-servo-engine-view/index.md) | `class ServoEngineView : `[`FrameLayout`](https://developer.android.com/reference/android/widget/FrameLayout.html)`, `[`EngineView`](./index.md)
Servo-based implementation of EngineView. | +| [SystemEngineView](../../mozilla.components.browser.engine.system/-system-engine-view/index.md) | `class SystemEngineView : `[`FrameLayout`](https://developer.android.com/reference/android/widget/FrameLayout.html)`, `[`EngineView`](./index.md)`, `[`OnLongClickListener`](https://developer.android.com/reference/android/view/View/OnLongClickListener.html)
WebView-based implementation of EngineView. | diff --git a/docs/api/mozilla.components.concept.engine/-engine-view/on-create.md b/docs/api/mozilla.components.concept.engine/-engine-view/on-create.md new file mode 100644 index 00000000000..21e0a64361e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-view/on-create.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineView](index.md) / [onCreate](./on-create.md) + +# onCreate + +`open fun onCreate(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L55) + +To be called in response to [Lifecycle.Event.ON_CREATE](#). See [EngineView](index.md) +implementations for details. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-view/on-destroy.md b/docs/api/mozilla.components.concept.engine/-engine-view/on-destroy.md new file mode 100644 index 00000000000..e04e7792cc4 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-view/on-destroy.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineView](index.md) / [onDestroy](./on-destroy.md) + +# onDestroy + +`open fun onDestroy(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L61) + +To be called in response to [Lifecycle.Event.ON_DESTROY](#). See [EngineView](index.md) +implementations for details. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-view/on-pause.md b/docs/api/mozilla.components.concept.engine/-engine-view/on-pause.md new file mode 100644 index 00000000000..58991c78365 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-view/on-pause.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineView](index.md) / [onPause](./on-pause.md) + +# onPause + +`open fun onPause(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L37) + +To be called in response to [Lifecycle.Event.ON_PAUSE](#). See [EngineView](index.md) +implementations for details. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-view/on-resume.md b/docs/api/mozilla.components.concept.engine/-engine-view/on-resume.md new file mode 100644 index 00000000000..651d6fa4dd6 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-view/on-resume.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineView](index.md) / [onResume](./on-resume.md) + +# onResume + +`open fun onResume(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L31) + +To be called in response to [Lifecycle.Event.ON_RESUME](#). See [EngineView](index.md) +implementations for details. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-view/on-start.md b/docs/api/mozilla.components.concept.engine/-engine-view/on-start.md new file mode 100644 index 00000000000..8a4016d99b6 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-view/on-start.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineView](index.md) / [onStart](./on-start.md) + +# onStart + +`open fun onStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L43) + +To be called in response to [Lifecycle.Event.ON_START](#). See [EngineView](index.md) +implementations for details. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-view/on-stop.md b/docs/api/mozilla.components.concept.engine/-engine-view/on-stop.md new file mode 100644 index 00000000000..d940e6c478c --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-view/on-stop.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineView](index.md) / [onStop](./on-stop.md) + +# onStop + +`open fun onStop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L49) + +To be called in response to [Lifecycle.Event.ON_STOP](#). See [EngineView](index.md) +implementations for details. + diff --git a/docs/api/mozilla.components.concept.engine/-engine-view/render.md b/docs/api/mozilla.components.concept.engine/-engine-view/render.md new file mode 100644 index 00000000000..166d520c3bc --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine-view/render.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [EngineView](index.md) / [render](./render.md) + +# render + +`abstract fun render(session: `[`EngineSession`](../-engine-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L25) + +Render the content of the given session. + diff --git a/docs/api/mozilla.components.concept.engine/-engine/create-session-state.md b/docs/api/mozilla.components.concept.engine/-engine/create-session-state.md new file mode 100644 index 00000000000..98f2b11d0be --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine/create-session-state.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Engine](index.md) / [createSessionState](./create-session-state.md) + +# createSessionState + +`abstract fun createSessionState(json: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`EngineSessionState`](../-engine-session-state/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Engine.kt#L38) + +Create a new [EngineSessionState](../-engine-session-state/index.md) instance from the serialized JSON representation. + diff --git a/docs/api/mozilla.components.concept.engine/-engine/create-session.md b/docs/api/mozilla.components.concept.engine/-engine/create-session.md new file mode 100644 index 00000000000..62d4dc12f19 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine/create-session.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Engine](index.md) / [createSession](./create-session.md) + +# createSession + +`abstract fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false): `[`EngineSession`](../-engine-session/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Engine.kt#L33) + +Creates a new engine session. + +### Parameters + +`private` - whether or not this session should use private mode. + +**Return** +the newly created [EngineSession](../-engine-session/index.md). + diff --git a/docs/api/mozilla.components.concept.engine/-engine/create-view.md b/docs/api/mozilla.components.concept.engine/-engine/create-view.md new file mode 100644 index 00000000000..01decfa7ce6 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine/create-view.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Engine](index.md) / [createView](./create-view.md) + +# createView + +`abstract fun createView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = null): `[`EngineView`](../-engine-view/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Engine.kt#L24) + +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.md). + diff --git a/docs/api/mozilla.components.concept.engine/-engine/index.md b/docs/api/mozilla.components.concept.engine/-engine/index.md new file mode 100644 index 00000000000..762d73133dc --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine/index.md @@ -0,0 +1,31 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Engine](./index.md) + +# Engine + +`interface Engine` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Engine.kt#L14) + +Entry point for interacting with the engine implementation. + +### Properties + +| Name | Summary | +|---|---| +| [settings](settings.md) | `abstract val settings: `[`Settings`](../-settings/index.md)
Provides access to the settings of this engine. | + +### Functions + +| Name | Summary | +|---|---| +| [createSession](create-session.md) | `abstract fun createSession(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false): `[`EngineSession`](../-engine-session/index.md)
Creates a new engine session. | +| [createSessionState](create-session-state.md) | `abstract fun createSessionState(json: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`EngineSessionState`](../-engine-session-state/index.md)
Create a new [EngineSessionState](../-engine-session-state/index.md) instance from the serialized JSON representation. | +| [createView](create-view.md) | `abstract fun createView(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = null): `[`EngineView`](../-engine-view/index.md)
Creates a new view for rendering web content. | +| [name](name.md) | `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. | +| [speculativeConnect](speculative-connect.md) | `abstract fun speculativeConnect(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)
Opens a speculative connection to the host of [url](speculative-connect.md#mozilla.components.concept.engine.Engine$speculativeConnect(kotlin.String)/url). | + +### Inheritors + +| Name | Summary | +|---|---| +| [GeckoEngine](../../mozilla.components.browser.engine.gecko/-gecko-engine/index.md) | `class GeckoEngine : `[`Engine`](./index.md)
Gecko-based implementation of Engine interface. | +| [ServoEngine](../../mozilla.components.browser.engine.servo/-servo-engine/index.md) | `class ServoEngine : `[`Engine`](./index.md)
Servo-based implementation of the Engine interface. | +| [SystemEngine](../../mozilla.components.browser.engine.system/-system-engine/index.md) | `class SystemEngine : `[`Engine`](./index.md)
WebView-based implementation of the Engine interface. | diff --git a/docs/api/mozilla.components.concept.engine/-engine/name.md b/docs/api/mozilla.components.concept.engine/-engine/name.md new file mode 100644 index 00000000000..e556e649f2e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine/name.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Engine](index.md) / [name](./name.md) + +# name + +`abstract fun name(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Engine.kt#L47) + +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/mozilla.components.concept.engine/-engine/settings.md b/docs/api/mozilla.components.concept.engine/-engine/settings.md new file mode 100644 index 00000000000..cd9b087c52c --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine/settings.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Engine](index.md) / [settings](./settings.md) + +# settings + +`abstract val settings: `[`Settings`](../-settings/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Engine.kt#L62) + +Provides access to the settings of this engine. + diff --git a/docs/api/mozilla.components.concept.engine/-engine/speculative-connect.md b/docs/api/mozilla.components.concept.engine/-engine/speculative-connect.md new file mode 100644 index 00000000000..2c3f5ac539b --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-engine/speculative-connect.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Engine](index.md) / [speculativeConnect](./speculative-connect.md) + +# speculativeConnect + +`abstract fun speculativeConnect(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Engine.kt#L57) + +Opens a speculative connection to the host of [url](speculative-connect.md#mozilla.components.concept.engine.Engine$speculativeConnect(kotlin.String)/url). + +This is useful if an app thinks it may be making a request to that host in the near future. If no request +is made, the connection will be cleaned up after an unspecified. + +Not all [Engine](index.md) implementations may actually implement this. + diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/-init-.md b/docs/api/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/-init-.md new file mode 100644 index 00000000000..74909956e9f --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [AUDIO](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/index.md b/docs/api/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/index.md new file mode 100644 index 00000000000..7001e58394f --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/index.md @@ -0,0 +1,19 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [AUDIO](./index.md) + +# AUDIO + +`data class AUDIO : `[`HitResult`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L31) + +If the HTML element was of type 'HTMLAudioElement'. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AUDIO(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
If the HTML element was of type 'HTMLAudioElement'. | + +### Properties + +| Name | Summary | +|---|---| +| [src](src.md) | `val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/src.md b/docs/api/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/src.md new file mode 100644 index 00000000000..2cab56554f6 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-a-u-d-i-o/src.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [AUDIO](index.md) / [src](./src.md) + +# src + +`val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L31) + +Overrides [HitResult.src](../src.md) + diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/-init-.md b/docs/api/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/-init-.md new file mode 100644 index 00000000000..a86837e6dd2 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [EMAIL](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/index.md b/docs/api/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/index.md new file mode 100644 index 00000000000..37b848dd499 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/index.md @@ -0,0 +1,19 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [EMAIL](./index.md) + +# EMAIL + +`data class EMAIL : `[`HitResult`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L46) + +The type used if the URI is prepended with 'mailto:'. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `EMAIL(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
The type used if the URI is prepended with 'mailto:'. | + +### Properties + +| Name | Summary | +|---|---| +| [src](src.md) | `val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/src.md b/docs/api/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/src.md new file mode 100644 index 00000000000..88cba75806e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-e-m-a-i-l/src.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [EMAIL](index.md) / [src](./src.md) + +# src + +`val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L46) + +Overrides [HitResult.src](../src.md) + diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/-g-e-o/-init-.md b/docs/api/mozilla.components.concept.engine/-hit-result/-g-e-o/-init-.md new file mode 100644 index 00000000000..70903ac1b5d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-g-e-o/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [GEO](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.concept.engine/-hit-result/-g-e-o/index.md b/docs/api/mozilla.components.concept.engine/-hit-result/-g-e-o/index.md new file mode 100644 index 00000000000..4428317d62a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-g-e-o/index.md @@ -0,0 +1,19 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [GEO](./index.md) + +# GEO + +`data class GEO : `[`HitResult`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L51) + +The type used if the URI is prepended with 'geo:'. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `GEO(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
The type used if the URI is prepended with 'geo:'. | + +### Properties + +| Name | Summary | +|---|---| +| [src](src.md) | `val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/-g-e-o/src.md b/docs/api/mozilla.components.concept.engine/-hit-result/-g-e-o/src.md new file mode 100644 index 00000000000..4449635fa36 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-g-e-o/src.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [GEO](index.md) / [src](./src.md) + +# src + +`val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L51) + +Overrides [HitResult.src](../src.md) + diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/-init-.md b/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/-init-.md new file mode 100644 index 00000000000..4d678f74b18 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [IMAGE](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/index.md b/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/index.md new file mode 100644 index 00000000000..6b5ef753722 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/index.md @@ -0,0 +1,19 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [IMAGE](./index.md) + +# IMAGE + +`data class IMAGE : `[`HitResult`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L21) + +If the HTML element was of type 'HTMLImageElement'. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `IMAGE(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
If the HTML element was of type 'HTMLImageElement'. | + +### Properties + +| Name | Summary | +|---|---| +| [src](src.md) | `val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/src.md b/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/src.md new file mode 100644 index 00000000000..795c37d2f59 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e/src.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [IMAGE](index.md) / [src](./src.md) + +# src + +`val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L21) + +Overrides [HitResult.src](../src.md) + diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/-init-.md b/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/-init-.md new file mode 100644 index 00000000000..7067cdc8b55 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [IMAGE_SRC](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/index.md b/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/index.md new file mode 100644 index 00000000000..57707e629bb --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/index.md @@ -0,0 +1,20 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [IMAGE_SRC](./index.md) + +# IMAGE_SRC + +`data class IMAGE_SRC : `[`HitResult`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L36) + +If the HTML element was of type 'HTMLImageElement' and contained a URI. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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 + +| Name | Summary | +|---|---| +| [src](src.md) | `val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [uri](uri.md) | `val uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/src.md b/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/src.md new file mode 100644 index 00000000000..813851c0bd6 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/src.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [IMAGE_SRC](index.md) / [src](./src.md) + +# src + +`val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L36) + +Overrides [HitResult.src](../src.md) + diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/uri.md b/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/uri.md new file mode 100644 index 00000000000..d06e77dc79e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-i-m-a-g-e_-s-r-c/uri.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [IMAGE_SRC](index.md) / [uri](./uri.md) + +# uri + +`val uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L36) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/-init-.md b/docs/api/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/-init-.md new file mode 100644 index 00000000000..5530424ab1a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [PHONE](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/index.md b/docs/api/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/index.md new file mode 100644 index 00000000000..3b5b8c37b2d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/index.md @@ -0,0 +1,19 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [PHONE](./index.md) + +# PHONE + +`data class PHONE : `[`HitResult`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L41) + +The type used if the URI is prepended with 'tel:'. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `PHONE(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
The type used if the URI is prepended with 'tel:'. | + +### Properties + +| Name | Summary | +|---|---| +| [src](src.md) | `val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/src.md b/docs/api/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/src.md new file mode 100644 index 00000000000..0e3691d6eda --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-p-h-o-n-e/src.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [PHONE](index.md) / [src](./src.md) + +# src + +`val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L41) + +Overrides [HitResult.src](../src.md) + diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/-init-.md b/docs/api/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/-init-.md new file mode 100644 index 00000000000..fc8cb1c33ee --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [UNKNOWN](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/index.md b/docs/api/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/index.md new file mode 100644 index 00000000000..a1b2e8c508f --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/index.md @@ -0,0 +1,19 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [UNKNOWN](./index.md) + +# UNKNOWN + +`data class UNKNOWN : `[`HitResult`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L16) + +Default type if we're unable to match the type to anything. It may or may not have a src. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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. | + +### Properties + +| Name | Summary | +|---|---| +| [src](src.md) | `val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/src.md b/docs/api/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/src.md new file mode 100644 index 00000000000..e68a015b595 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-u-n-k-n-o-w-n/src.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [UNKNOWN](index.md) / [src](./src.md) + +# src + +`val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L16) + +Overrides [HitResult.src](../src.md) + diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/-init-.md b/docs/api/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/-init-.md new file mode 100644 index 00000000000..b3244265904 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [VIDEO](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/index.md b/docs/api/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/index.md new file mode 100644 index 00000000000..0ab45da373e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/index.md @@ -0,0 +1,19 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [VIDEO](./index.md) + +# VIDEO + +`data class VIDEO : `[`HitResult`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L26) + +If the HTML element was of type 'HTMLVideoElement'. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `VIDEO(src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
If the HTML element was of type 'HTMLVideoElement'. | + +### Properties + +| Name | Summary | +|---|---| +| [src](src.md) | `val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/src.md b/docs/api/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/src.md new file mode 100644 index 00000000000..b76aeab9e3d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/-v-i-d-e-o/src.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.engine](../../index.md) / [HitResult](../index.md) / [VIDEO](index.md) / [src](./src.md) + +# src + +`val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L26) + +Overrides [HitResult.src](../src.md) + diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/index.md b/docs/api/mozilla.components.concept.engine/-hit-result/index.md new file mode 100644 index 00000000000..00253387793 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/index.md @@ -0,0 +1,40 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [HitResult](./index.md) + +# HitResult + +`sealed class HitResult` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L12) + +Represents all the different supported types of data that can be found from long clicking +an element. + +### Types + +| Name | Summary | +|---|---| +| [AUDIO](-a-u-d-i-o/index.md) | `data class AUDIO : `[`HitResult`](./index.md)
If the HTML element was of type 'HTMLAudioElement'. | +| [EMAIL](-e-m-a-i-l/index.md) | `data class EMAIL : `[`HitResult`](./index.md)
The type used if the URI is prepended with 'mailto:'. | +| [GEO](-g-e-o/index.md) | `data class GEO : `[`HitResult`](./index.md)
The type used if the URI is prepended with 'geo:'. | +| [IMAGE](-i-m-a-g-e/index.md) | `data class IMAGE : `[`HitResult`](./index.md)
If the HTML element was of type 'HTMLImageElement'. | +| [IMAGE_SRC](-i-m-a-g-e_-s-r-c/index.md) | `data 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.md) | `data class PHONE : `[`HitResult`](./index.md)
The type used if the URI is prepended with 'tel:'. | +| [UNKNOWN](-u-n-k-n-o-w-n/index.md) | `data 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.md) | `data class VIDEO : `[`HitResult`](./index.md)
If the HTML element was of type 'HTMLVideoElement'. | + +### Properties + +| Name | Summary | +|---|---| +| [src](src.md) | `open val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [AUDIO](-a-u-d-i-o/index.md) | `data class AUDIO : `[`HitResult`](./index.md)
If the HTML element was of type 'HTMLAudioElement'. | +| [EMAIL](-e-m-a-i-l/index.md) | `data class EMAIL : `[`HitResult`](./index.md)
The type used if the URI is prepended with 'mailto:'. | +| [GEO](-g-e-o/index.md) | `data class GEO : `[`HitResult`](./index.md)
The type used if the URI is prepended with 'geo:'. | +| [IMAGE](-i-m-a-g-e/index.md) | `data class IMAGE : `[`HitResult`](./index.md)
If the HTML element was of type 'HTMLImageElement'. | +| [IMAGE_SRC](-i-m-a-g-e_-s-r-c/index.md) | `data 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.md) | `data class PHONE : `[`HitResult`](./index.md)
The type used if the URI is prepended with 'tel:'. | +| [UNKNOWN](-u-n-k-n-o-w-n/index.md) | `data 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.md) | `data class VIDEO : `[`HitResult`](./index.md)
If the HTML element was of type 'HTMLVideoElement'. | diff --git a/docs/api/mozilla.components.concept.engine/-hit-result/src.md b/docs/api/mozilla.components.concept.engine/-hit-result/src.md new file mode 100644 index 00000000000..2366a3a9dc7 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-hit-result/src.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [HitResult](index.md) / [src](./src.md) + +# src + +`open val src: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/HitResult.kt#L12) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-lifecycle-observer/-init-.md b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/-init-.md new file mode 100644 index 00000000000..98601781083 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [LifecycleObserver](index.md) / [<init>](./-init-.md) + +# <init> + +`LifecycleObserver(engineView: `[`EngineView`](../-engine-view/index.md)`)` + +[LifecycleObserver](#) which dispatches lifecycle events to an [EngineView](../-engine-view/index.md). + diff --git a/docs/api/mozilla.components.concept.engine/-lifecycle-observer/engine-view.md b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/engine-view.md new file mode 100644 index 00000000000..1ccd9838839 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/engine-view.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [LifecycleObserver](index.md) / [engineView](./engine-view.md) + +# engineView + +`val engineView: `[`EngineView`](../-engine-view/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L73) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-lifecycle-observer/index.md b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/index.md new file mode 100644 index 00000000000..c1b4ab576e1 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/index.md @@ -0,0 +1,30 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [LifecycleObserver](./index.md) + +# LifecycleObserver + +`class LifecycleObserver : LifecycleObserver` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L73) + +[LifecycleObserver](#) which dispatches lifecycle events to an [EngineView](../-engine-view/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `LifecycleObserver(engineView: `[`EngineView`](../-engine-view/index.md)`)`
[LifecycleObserver](#) which dispatches lifecycle events to an [EngineView](../-engine-view/index.md). | + +### Properties + +| Name | Summary | +|---|---| +| [engineView](engine-view.md) | `val engineView: `[`EngineView`](../-engine-view/index.md) | + +### Functions + +| Name | Summary | +|---|---| +| [onCreate](on-create.md) | `fun onCreate(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onDestroy](on-destroy.md) | `fun onDestroy(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onPause](on-pause.md) | `fun onPause(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onResume](on-resume.md) | `fun onResume(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onStart](on-start.md) | `fun onStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onStop](on-stop.md) | `fun onStop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-create.md b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-create.md new file mode 100644 index 00000000000..27a702c6147 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-create.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [LifecycleObserver](index.md) / [onCreate](./on-create.md) + +# onCreate + +`fun onCreate(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L96) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-destroy.md b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-destroy.md new file mode 100644 index 00000000000..e1c9fb8eafe --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-destroy.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [LifecycleObserver](index.md) / [onDestroy](./on-destroy.md) + +# onDestroy + +`fun onDestroy(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L101) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-pause.md b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-pause.md new file mode 100644 index 00000000000..0ba95eed1c7 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-pause.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [LifecycleObserver](index.md) / [onPause](./on-pause.md) + +# onPause + +`fun onPause(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L76) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-resume.md b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-resume.md new file mode 100644 index 00000000000..cad77b1e4bf --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-resume.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [LifecycleObserver](index.md) / [onResume](./on-resume.md) + +# onResume + +`fun onResume(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L81) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-start.md b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-start.md new file mode 100644 index 00000000000..f5f802cfec9 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-start.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [LifecycleObserver](index.md) / [onStart](./on-start.md) + +# onStart + +`fun onStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L86) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-stop.md b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-stop.md new file mode 100644 index 00000000000..2ebb65c54f6 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-lifecycle-observer/on-stop.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [LifecycleObserver](index.md) / [onStop](./on-stop.md) + +# onStop + +`fun onStop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineView.kt#L91) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-settings/-init-.md b/docs/api/mozilla.components.concept.engine/-settings/-init-.md new file mode 100644 index 00000000000..d055f6cb2f4 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/-init-.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [<init>](./-init-.md) + +# <init> + +`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. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/allow-content-access.md b/docs/api/mozilla.components.concept.engine/-settings/allow-content-access.md new file mode 100644 index 00000000000..3f7826e80a9 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/allow-content-access.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [allowContentAccess](./allow-content-access.md) + +# allowContentAccess + +`open var allowContentAccess: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L95) + +Setting to control whether or not the engine is allowed to load content from a content +provider installed in the system. + +**Getter** + +Setting to control whether or not the engine is allowed to load content from a content +provider installed in the system. + +**Setter** + +Setting to control whether or not the engine is allowed to load content from a content +provider installed in the system. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/allow-file-access-from-file-u-r-ls.md b/docs/api/mozilla.components.concept.engine/-settings/allow-file-access-from-file-u-r-ls.md new file mode 100644 index 00000000000..6cde3871530 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/allow-file-access-from-file-u-r-ls.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [allowFileAccessFromFileURLs](./allow-file-access-from-file-u-r-ls.md) + +# allowFileAccessFromFileURLs + +`open var allowFileAccessFromFileURLs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L83) + +Setting to control whether or not JavaScript running in the context of a file scheme URL +should be allowed to access content from other file scheme URLs. + +**Getter** + +Setting to control whether or not JavaScript running in the context of a file scheme URL +should be allowed to access content from other file scheme URLs. + +**Setter** + +Setting to control whether or not JavaScript running in the context of a file scheme URL +should be allowed to access content from other file scheme URLs. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/allow-file-access.md b/docs/api/mozilla.components.concept.engine/-settings/allow-file-access.md new file mode 100644 index 00000000000..929caa421f0 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/allow-file-access.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [allowFileAccess](./allow-file-access.md) + +# allowFileAccess + +`open var allowFileAccess: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L77) + +Setting to control whether or not file access is allowed. + +**Getter** + +Setting to control whether or not file access is allowed. + +**Setter** + +Setting to control whether or not file access is allowed. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/allow-universal-access-from-file-u-r-ls.md b/docs/api/mozilla.components.concept.engine/-settings/allow-universal-access-from-file-u-r-ls.md new file mode 100644 index 00000000000..7164128727d --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/allow-universal-access-from-file-u-r-ls.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [allowUniversalAccessFromFileURLs](./allow-universal-access-from-file-u-r-ls.md) + +# allowUniversalAccessFromFileURLs + +`open var allowUniversalAccessFromFileURLs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L89) + +Setting to control whether or not JavaScript running in the context of a file scheme URL +should be allowed to access content from any origin. + +**Getter** + +Setting to control whether or not JavaScript running in the context of a file scheme URL +should be allowed to access content from any origin. + +**Setter** + +Setting to control whether or not JavaScript running in the context of a file scheme URL +should be allowed to access content from any origin. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/display-zoom-controls.md b/docs/api/mozilla.components.concept.engine/-settings/display-zoom-controls.md new file mode 100644 index 00000000000..6632c6bd256 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/display-zoom-controls.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [displayZoomControls](./display-zoom-controls.md) + +# displayZoomControls + +`open var displayZoomControls: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L67) + +Setting to control whether or not zoom controls should be displayed. + +**Getter** + +Setting to control whether or not zoom controls should be displayed. + +**Setter** + +Setting to control whether or not zoom controls should be displayed. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/dom-storage-enabled.md b/docs/api/mozilla.components.concept.engine/-settings/dom-storage-enabled.md new file mode 100644 index 00000000000..a8df67b0980 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/dom-storage-enabled.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [domStorageEnabled](./dom-storage-enabled.md) + +# domStorageEnabled + +`open var domStorageEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L27) + +Setting to control whether or not DOM Storage is enabled. + +**Getter** + +Setting to control whether or not DOM Storage is enabled. + +**Setter** + +Setting to control whether or not DOM Storage is enabled. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/history-tracking-delegate.md b/docs/api/mozilla.components.concept.engine/-settings/history-tracking-delegate.md new file mode 100644 index 00000000000..cd73660f1d7 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/history-tracking-delegate.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [historyTrackingDelegate](./history-tracking-delegate.md) + +# historyTrackingDelegate + +`open var historyTrackingDelegate: `[`HistoryTrackingDelegate`](../../mozilla.components.concept.engine.history/-history-tracking-delegate/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L47) + +Setting to provide a history delegate to the engine. + +**Getter** + +Setting to provide a history delegate to the engine. + +**Setter** + +Setting to provide a history delegate to the engine. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/horizontal-scroll-bar-enabled.md b/docs/api/mozilla.components.concept.engine/-settings/horizontal-scroll-bar-enabled.md new file mode 100644 index 00000000000..48eb8462a1b --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/horizontal-scroll-bar-enabled.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [horizontalScrollBarEnabled](./horizontal-scroll-bar-enabled.md) + +# horizontalScrollBarEnabled + +`open var horizontalScrollBarEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L105) + +Setting to control whether or not horizontal scrolling is enabled. + +**Getter** + +Setting to control whether or not horizontal scrolling is enabled. + +**Setter** + +Setting to control whether or not horizontal scrolling is enabled. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/index.md b/docs/api/mozilla.components.concept.engine/-settings/index.md new file mode 100644 index 00000000000..eb57bc547ff --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/index.md @@ -0,0 +1,46 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](./index.md) + +# Settings + +`abstract class Settings` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L18) + +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. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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 + +| Name | Summary | +|---|---| +| [allowContentAccess](allow-content-access.md) | `open var allowContentAccess: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not the engine is allowed to load content from a content provider installed in the system. | +| [allowFileAccess](allow-file-access.md) | `open var allowFileAccess: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not file access is allowed. | +| [allowFileAccessFromFileURLs](allow-file-access-from-file-u-r-ls.md) | `open var allowFileAccessFromFileURLs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not JavaScript running in the context of a file scheme URL should be allowed to access content from other file scheme URLs. | +| [allowUniversalAccessFromFileURLs](allow-universal-access-from-file-u-r-ls.md) | `open var allowUniversalAccessFromFileURLs: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not JavaScript running in the context of a file scheme URL should be allowed to access content from any origin. | +| [displayZoomControls](display-zoom-controls.md) | `open var displayZoomControls: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not zoom controls should be displayed. | +| [domStorageEnabled](dom-storage-enabled.md) | `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. | +| [historyTrackingDelegate](history-tracking-delegate.md) | `open var historyTrackingDelegate: `[`HistoryTrackingDelegate`](../../mozilla.components.concept.engine.history/-history-tracking-delegate/index.md)`?`
Setting to provide a history delegate to the engine. | +| [horizontalScrollBarEnabled](horizontal-scroll-bar-enabled.md) | `open var horizontalScrollBarEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not horizontal scrolling is enabled. | +| [javaScriptCanOpenWindowsAutomatically](java-script-can-open-windows-automatically.md) | `open var javaScriptCanOpenWindowsAutomatically: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not window.open can be called from JavaScript. | +| [javascriptEnabled](javascript-enabled.md) | `open var javascriptEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not JavaScript is enabled. | +| [loadWithOverviewMode](load-with-overview-mode.md) | `open var loadWithOverviewMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not the engine zooms out the content to fit on screen by width. | +| [mediaPlaybackRequiresUserGesture](media-playback-requires-user-gesture.md) | `open var mediaPlaybackRequiresUserGesture: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not a user gesture is required to play media. | +| [remoteDebuggingEnabled](remote-debugging-enabled.md) | `open var remoteDebuggingEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not remote debugging is enabled. | +| [requestInterceptor](request-interceptor.md) | `open var requestInterceptor: `[`RequestInterceptor`](../../mozilla.components.concept.engine.request/-request-interceptor/index.md)`?`
Setting to intercept and override requests. | +| [supportMultipleWindows](support-multiple-windows.md) | `open var supportMultipleWindows: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not multiple windows are supported. | +| [testingModeEnabled](testing-mode-enabled.md) | `open var testingModeEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not testing mode is enabled. | +| [trackingProtectionPolicy](tracking-protection-policy.md) | `open var trackingProtectionPolicy: `[`TrackingProtectionPolicy`](../-engine-session/-tracking-protection-policy/index.md)`?`
Setting to control tracking protection. | +| [userAgentString](user-agent-string.md) | `open var userAgentString: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Setting to control the user agent string. | +| [verticalScrollBarEnabled](vertical-scroll-bar-enabled.md) | `open var verticalScrollBarEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not vertical scrolling is enabled. | +| [webFontsEnabled](web-fonts-enabled.md) | `open var webFontsEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Setting to control whether or not Web fonts are enabled. | + +### Inheritors + +| Name | Summary | +|---|---| +| [DefaultSettings](../-default-settings/index.md) | `data class DefaultSettings : `[`Settings`](./index.md)
[Settings](./index.md) implementation used to set defaults for [Engine](../-engine/index.md) and [EngineSession](../-engine-session/index.md). | diff --git a/docs/api/mozilla.components.concept.engine/-settings/java-script-can-open-windows-automatically.md b/docs/api/mozilla.components.concept.engine/-settings/java-script-can-open-windows-automatically.md new file mode 100644 index 00000000000..8a5c9ce8acd --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/java-script-can-open-windows-automatically.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [javaScriptCanOpenWindowsAutomatically](./java-script-can-open-windows-automatically.md) + +# javaScriptCanOpenWindowsAutomatically + +`open var javaScriptCanOpenWindowsAutomatically: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L62) + +Setting to control whether or not window.open can be called from JavaScript. + +**Getter** + +Setting to control whether or not window.open can be called from JavaScript. + +**Setter** + +Setting to control whether or not window.open can be called from JavaScript. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/javascript-enabled.md b/docs/api/mozilla.components.concept.engine/-settings/javascript-enabled.md new file mode 100644 index 00000000000..2bc29962745 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/javascript-enabled.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [javascriptEnabled](./javascript-enabled.md) + +# javascriptEnabled + +`open var javascriptEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L22) + +Setting to control whether or not JavaScript is enabled. + +**Getter** + +Setting to control whether or not JavaScript is enabled. + +**Setter** + +Setting to control whether or not JavaScript is enabled. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/load-with-overview-mode.md b/docs/api/mozilla.components.concept.engine/-settings/load-with-overview-mode.md new file mode 100644 index 00000000000..983853c2459 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/load-with-overview-mode.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [loadWithOverviewMode](./load-with-overview-mode.md) + +# loadWithOverviewMode + +`open var loadWithOverviewMode: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L72) + +Setting to control whether or not the engine zooms out the content to fit on screen by width. + +**Getter** + +Setting to control whether or not the engine zooms out the content to fit on screen by width. + +**Setter** + +Setting to control whether or not the engine zooms out the content to fit on screen by width. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/media-playback-requires-user-gesture.md b/docs/api/mozilla.components.concept.engine/-settings/media-playback-requires-user-gesture.md new file mode 100644 index 00000000000..a0941bc73cd --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/media-playback-requires-user-gesture.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [mediaPlaybackRequiresUserGesture](./media-playback-requires-user-gesture.md) + +# mediaPlaybackRequiresUserGesture + +`open var mediaPlaybackRequiresUserGesture: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L57) + +Setting to control whether or not a user gesture is required to play media. + +**Getter** + +Setting to control whether or not a user gesture is required to play media. + +**Setter** + +Setting to control whether or not a user gesture is required to play media. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/remote-debugging-enabled.md b/docs/api/mozilla.components.concept.engine/-settings/remote-debugging-enabled.md new file mode 100644 index 00000000000..64d57c4c013 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/remote-debugging-enabled.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [remoteDebuggingEnabled](./remote-debugging-enabled.md) + +# remoteDebuggingEnabled + +`open var remoteDebuggingEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L110) + +Setting to control whether or not remote debugging is enabled. + +**Getter** + +Setting to control whether or not remote debugging is enabled. + +**Setter** + +Setting to control whether or not remote debugging is enabled. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/request-interceptor.md b/docs/api/mozilla.components.concept.engine/-settings/request-interceptor.md new file mode 100644 index 00000000000..162c0632593 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/request-interceptor.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [requestInterceptor](./request-interceptor.md) + +# requestInterceptor + +`open var requestInterceptor: `[`RequestInterceptor`](../../mozilla.components.concept.engine.request/-request-interceptor/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L42) + +Setting to intercept and override requests. + +**Getter** + +Setting to intercept and override requests. + +**Setter** + +Setting to intercept and override requests. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/support-multiple-windows.md b/docs/api/mozilla.components.concept.engine/-settings/support-multiple-windows.md new file mode 100644 index 00000000000..10a951f8ebb --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/support-multiple-windows.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [supportMultipleWindows](./support-multiple-windows.md) + +# supportMultipleWindows + +`open var supportMultipleWindows: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L115) + +Setting to control whether or not multiple windows are supported. + +**Getter** + +Setting to control whether or not multiple windows are supported. + +**Setter** + +Setting to control whether or not multiple windows are supported. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/testing-mode-enabled.md b/docs/api/mozilla.components.concept.engine/-settings/testing-mode-enabled.md new file mode 100644 index 00000000000..32f62256fb8 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/testing-mode-enabled.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [testingModeEnabled](./testing-mode-enabled.md) + +# testingModeEnabled + +`open var testingModeEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L120) + +Setting to control whether or not testing mode is enabled. + +**Getter** + +Setting to control whether or not testing mode is enabled. + +**Setter** + +Setting to control whether or not testing mode is enabled. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/tracking-protection-policy.md b/docs/api/mozilla.components.concept.engine/-settings/tracking-protection-policy.md new file mode 100644 index 00000000000..53a7f7c5bd5 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/tracking-protection-policy.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [trackingProtectionPolicy](./tracking-protection-policy.md) + +# trackingProtectionPolicy + +`open var trackingProtectionPolicy: `[`TrackingProtectionPolicy`](../-engine-session/-tracking-protection-policy/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L37) + +Setting to control tracking protection. + +**Getter** + +Setting to control tracking protection. + +**Setter** + +Setting to control tracking protection. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/user-agent-string.md b/docs/api/mozilla.components.concept.engine/-settings/user-agent-string.md new file mode 100644 index 00000000000..ffeed81b09e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/user-agent-string.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [userAgentString](./user-agent-string.md) + +# userAgentString + +`open var userAgentString: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L52) + +Setting to control the user agent string. + +**Getter** + +Setting to control the user agent string. + +**Setter** + +Setting to control the user agent string. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/vertical-scroll-bar-enabled.md b/docs/api/mozilla.components.concept.engine/-settings/vertical-scroll-bar-enabled.md new file mode 100644 index 00000000000..ea9243a63c2 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/vertical-scroll-bar-enabled.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [verticalScrollBarEnabled](./vertical-scroll-bar-enabled.md) + +# verticalScrollBarEnabled + +`open var verticalScrollBarEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L100) + +Setting to control whether or not vertical scrolling is enabled. + +**Getter** + +Setting to control whether or not vertical scrolling is enabled. + +**Setter** + +Setting to control whether or not vertical scrolling is enabled. + diff --git a/docs/api/mozilla.components.concept.engine/-settings/web-fonts-enabled.md b/docs/api/mozilla.components.concept.engine/-settings/web-fonts-enabled.md new file mode 100644 index 00000000000..9e4b446439e --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-settings/web-fonts-enabled.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [Settings](index.md) / [webFontsEnabled](./web-fonts-enabled.md) + +# webFontsEnabled + +`open var webFontsEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L32) + +Setting to control whether or not Web fonts are enabled. + +**Getter** + +Setting to control whether or not Web fonts are enabled. + +**Setter** + +Setting to control whether or not Web fonts are enabled. + diff --git a/docs/api/mozilla.components.concept.engine/-unsupported-setting-exception/-init-.md b/docs/api/mozilla.components.concept.engine/-unsupported-setting-exception/-init-.md new file mode 100644 index 00000000000..8b8d0eff3b7 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-unsupported-setting-exception/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [UnsupportedSettingException](index.md) / [<init>](./-init-.md) + +# <init> + +`UnsupportedSettingException(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "Setting not supported by this engine")` + +Exception thrown by default if a setting is not supported by an engine or session. + diff --git a/docs/api/mozilla.components.concept.engine/-unsupported-setting-exception/index.md b/docs/api/mozilla.components.concept.engine/-unsupported-setting-exception/index.md new file mode 100644 index 00000000000..5b408005b4a --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-unsupported-setting-exception/index.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [UnsupportedSettingException](./index.md) + +# UnsupportedSettingException + +`class UnsupportedSettingException : `[`RuntimeException`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-runtime-exception/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L164) + +Exception thrown by default if a setting is not supported by an engine or session. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `UnsupportedSettingException(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "Setting not supported by this engine")`
Exception thrown by default if a setting is not supported by an engine or session. | diff --git a/docs/api/mozilla.components.concept.engine/-unsupported-setting/-init-.md b/docs/api/mozilla.components.concept.engine/-unsupported-setting/-init-.md new file mode 100644 index 00000000000..797361c1bcb --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-unsupported-setting/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [UnsupportedSetting](index.md) / [<init>](./-init-.md) + +# <init> + +`UnsupportedSetting()` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-unsupported-setting/get-value.md b/docs/api/mozilla.components.concept.engine/-unsupported-setting/get-value.md new file mode 100644 index 00000000000..2b84c6d776b --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-unsupported-setting/get-value.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [UnsupportedSetting](index.md) / [getValue](./get-value.md) + +# getValue + +`operator fun getValue(thisRef: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?, prop: `[`KProperty`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-property/index.html)`<*>): `[`T`](index.md#T) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L150) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/-unsupported-setting/index.md b/docs/api/mozilla.components.concept.engine/-unsupported-setting/index.md new file mode 100644 index 00000000000..17304f9df94 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-unsupported-setting/index.md @@ -0,0 +1,18 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [UnsupportedSetting](./index.md) + +# UnsupportedSetting + +`class UnsupportedSetting` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L149) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `UnsupportedSetting()` | + +### Functions + +| Name | Summary | +|---|---| +| [getValue](get-value.md) | `operator fun getValue(thisRef: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?, prop: `[`KProperty`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-property/index.html)`<*>): `[`T`](index.md#T) | +| [setValue](set-value.md) | `operator fun setValue(thisRef: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?, prop: `[`KProperty`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-property/index.html)`<*>, value: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.concept.engine/-unsupported-setting/set-value.md b/docs/api/mozilla.components.concept.engine/-unsupported-setting/set-value.md new file mode 100644 index 00000000000..dc81d57998c --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/-unsupported-setting/set-value.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.engine](../index.md) / [UnsupportedSetting](index.md) / [setValue](./set-value.md) + +# setValue + +`operator fun setValue(thisRef: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?, prop: `[`KProperty`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-property/index.html)`<*>, value: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/engine/src/main/java/mozilla/components/concept/engine/Settings.kt#L155) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.engine/index.md b/docs/api/mozilla.components.concept.engine/index.md new file mode 100644 index 00000000000..02e347d4e40 --- /dev/null +++ b/docs/api/mozilla.components.concept.engine/index.md @@ -0,0 +1,23 @@ +[android-components](../index.md) / [mozilla.components.concept.engine](./index.md) + +## Package mozilla.components.concept.engine + +### Types + +| Name | Summary | +|---|---| +| [DefaultSettings](-default-settings/index.md) | `data class DefaultSettings : `[`Settings`](-settings/index.md)
[Settings](-settings/index.md) implementation used to set defaults for [Engine](-engine/index.md) and [EngineSession](-engine-session/index.md). | +| [Engine](-engine/index.md) | `interface Engine`
Entry point for interacting with the engine implementation. | +| [EngineSession](-engine-session/index.md) | `abstract class EngineSession : `[`Observable`](../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](-engine-session/-observer/index.md)`>`
Class representing a single engine session. | +| [EngineSessionState](-engine-session-state/index.md) | `interface EngineSessionState`
The state of an [EngineSession](-engine-session/index.md). An instance can be obtained from [EngineSession.saveState](-engine-session/save-state.md). Creating a new [EngineSession](-engine-session/index.md) and calling [EngineSession.restoreState](-engine-session/restore-state.md) with the same state instance should restore the previous session. | +| [EngineView](-engine-view/index.md) | `interface EngineView`
View component that renders web content. | +| [HitResult](-hit-result/index.md) | `sealed class HitResult`
Represents all the different supported types of data that can be found from long clicking an element. | +| [LifecycleObserver](-lifecycle-observer/index.md) | `class LifecycleObserver : LifecycleObserver`
[LifecycleObserver](#) which dispatches lifecycle events to an [EngineView](-engine-view/index.md). | +| [Settings](-settings/index.md) | `abstract class 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. | +| [UnsupportedSetting](-unsupported-setting/index.md) | `class UnsupportedSetting` | + +### Exceptions + +| Name | Summary | +|---|---| +| [UnsupportedSettingException](-unsupported-setting-exception/index.md) | `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/mozilla.components.concept.fetch/-client/-init-.md b/docs/api/mozilla.components.concept.fetch/-client/-init-.md new file mode 100644 index 00000000000..78e49064d9b --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-client/-init-.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Client](index.md) / [<init>](./-init-.md) + +# <init> + +`Client()` + +A generic [Client](index.md) for fetching resources via HTTP/s. + +Abstract base class / interface for clients implementing the `concept-fetch` component. + +The [Request](../-request/index.md)/[Response](../-response/index.md) API is inspired by the Web Fetch API: +https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API + diff --git a/docs/api/mozilla.components.concept.fetch/-client/default-headers.md b/docs/api/mozilla.components.concept.fetch/-client/default-headers.md new file mode 100644 index 00000000000..6ecf82f79d3 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-client/default-headers.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Client](index.md) / [defaultHeaders](./default-headers.md) + +# defaultHeaders + +`protected val defaultHeaders: `[`Headers`](../-headers/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Client.kt#L45) + +List of default headers that should be added to every request unless overridden by the headers in the request. + diff --git a/docs/api/mozilla.components.concept.fetch/-client/fetch.md b/docs/api/mozilla.components.concept.fetch/-client/fetch.md new file mode 100644 index 00000000000..ba414579f14 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-client/fetch.md @@ -0,0 +1,33 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Client](index.md) / [fetch](./fetch.md) + +# fetch + +`abstract fun fetch(request: `[`Request`](../-request/index.md)`): `[`Response`](../-response/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Client.kt#L40) + +Starts the process of fetching a resource from the network as described by the [Request](../-request/index.md) object. + +A [Response](../-response/index.md) may keep references to open streams. Therefore it's important to always close the [Response](../-response/index.md) or +its [Response.Body](../-response/-body/index.md). + +Use the `use()` extension method when performing multiple operations on the [Response](../-response/index.md) object: + +``` Kotlin +client.fetch(request).use { response -> + // Use response. Resources will get released automatically at the end of the block. +} +``` + +Alternatively you can use multiple `use*()` methods on the [Response.Body](../-response/-body/index.md) object. + +### Parameters + +`request` - The request to be executed by this [Client](index.md). + +### Exceptions + +`IOException` - if the request could not be executed due to cancellation, a connectivity problem or a +timeout. + +**Return** +The [Response](../-response/index.md) returned by the server. + diff --git a/docs/api/mozilla.components.concept.fetch/-client/index.md b/docs/api/mozilla.components.concept.fetch/-client/index.md new file mode 100644 index 00000000000..3ef3ead2191 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-client/index.md @@ -0,0 +1,38 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Client](./index.md) + +# Client + +`abstract class Client` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Client.kt#L17) + +A generic [Client](./index.md) for fetching resources via HTTP/s. + +Abstract base class / interface for clients implementing the `concept-fetch` component. + +The [Request](../-request/index.md)/[Response](../-response/index.md) API is inspired by the Web Fetch API: +https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Client()`
A generic [Client](./index.md) for fetching resources via HTTP/s. | + +### Properties + +| Name | Summary | +|---|---| +| [defaultHeaders](default-headers.md) | `val defaultHeaders: `[`Headers`](../-headers/index.md)
List of default headers that should be added to every request unless overridden by the headers in the request. | + +### Functions + +| Name | Summary | +|---|---| +| [fetch](fetch.md) | `abstract fun fetch(request: `[`Request`](../-request/index.md)`): `[`Response`](../-response/index.md)
Starts the process of fetching a resource from the network as described by the [Request](../-request/index.md) object. | + +### Inheritors + +| Name | Summary | +|---|---| +| [GeckoViewFetchClient](../../mozilla.components.browser.engine.gecko.fetch/-gecko-view-fetch-client/index.md) | `class GeckoViewFetchClient : `[`Client`](./index.md)
GeckoView ([GeckoWebExecutor](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoWebExecutor.html)) based implementation of [Client](./index.md). | +| [HttpURLConnectionClient](../../mozilla.components.lib.fetch.httpurlconnection/-http-u-r-l-connection-client/index.md) | `class HttpURLConnectionClient : `[`Client`](./index.md)
[HttpURLConnection](https://developer.android.com/reference/java/net/HttpURLConnection.html) implementation of [Client](./index.md). | +| [OkHttpClient](../../mozilla.components.lib.fetch.okhttp/-ok-http-client/index.md) | `class OkHttpClient : `[`Client`](./index.md)
[Client](./index.md) implementation using OkHttp. | diff --git a/docs/api/mozilla.components.concept.fetch/-header/-init-.md b/docs/api/mozilla.components.concept.fetch/-header/-init-.md new file mode 100644 index 00000000000..ba69b84e4b3 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-header/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Header](index.md) / [<init>](./-init-.md) + +# <init> + +`Header(name: `[`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)`)` + +Represents a [Header](index.md) containing of a [name](-init-.md#mozilla.components.concept.fetch.Header$(kotlin.String, kotlin.String)/name) and [value](-init-.md#mozilla.components.concept.fetch.Header$(kotlin.String, kotlin.String)/value). + diff --git a/docs/api/mozilla.components.concept.fetch/-header/index.md b/docs/api/mozilla.components.concept.fetch/-header/index.md new file mode 100644 index 00000000000..74a1500735f --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-header/index.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Header](./index.md) + +# Header + +`data class Header` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L47) + +Represents a [Header](./index.md) containing of a [name](name.md) and [value](value.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Header(name: `[`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)`)`
Represents a [Header](./index.md) containing of a [name](-init-.md#mozilla.components.concept.fetch.Header$(kotlin.String, kotlin.String)/name) and [value](-init-.md#mozilla.components.concept.fetch.Header$(kotlin.String, kotlin.String)/value). | + +### Properties + +| Name | Summary | +|---|---| +| [name](name.md) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [value](value.md) | `val value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.concept.fetch/-header/name.md b/docs/api/mozilla.components.concept.fetch/-header/name.md new file mode 100644 index 00000000000..85b98a60156 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-header/name.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Header](index.md) / [name](./name.md) + +# name + +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L48) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-header/value.md b/docs/api/mozilla.components.concept.fetch/-header/value.md new file mode 100644 index 00000000000..60857745cc4 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-header/value.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Header](index.md) / [value](./value.md) + +# value + +`val value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L49) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-headers/contains.md b/docs/api/mozilla.components.concept.fetch/-headers/contains.md new file mode 100644 index 00000000000..66854e43b2a --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-headers/contains.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Headers](index.md) / [contains](./contains.md) + +# contains + +`abstract operator fun contains(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L41) + +Returns true if a [Header](../-header/index.md) with the given [name](contains.md#mozilla.components.concept.fetch.Headers$contains(kotlin.String)/name) exists. + diff --git a/docs/api/mozilla.components.concept.fetch/-headers/get-all.md b/docs/api/mozilla.components.concept.fetch/-headers/get-all.md new file mode 100644 index 00000000000..9e95ab66fd4 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-headers/get-all.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Headers](index.md) / [getAll](./get-all.md) + +# getAll + +`abstract fun getAll(name: `[`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)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L31) + +Returns the list of values corresponding to the specified header field name. + diff --git a/docs/api/mozilla.components.concept.fetch/-headers/get.md b/docs/api/mozilla.components.concept.fetch/-headers/get.md new file mode 100644 index 00000000000..63b2187a4a7 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-headers/get.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Headers](index.md) / [get](./get.md) + +# get + +`abstract operator fun get(index: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Header`](../-header/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L21) + +Gets the [Header](../-header/index.md) at the specified [index](get.md#mozilla.components.concept.fetch.Headers$get(kotlin.Int)/index). + +`abstract operator fun get(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)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L26) + +Returns the last values corresponding to the specified header field name. Or null if the header does not exist. + diff --git a/docs/api/mozilla.components.concept.fetch/-headers/index.md b/docs/api/mozilla.components.concept.fetch/-headers/index.md new file mode 100644 index 00000000000..8b59144c9e2 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-headers/index.md @@ -0,0 +1,28 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Headers](./index.md) + +# Headers + +`interface Headers : `[`Iterable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterable/index.html)`<`[`Header`](../-header/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L12) + +A collection of HTTP [Headers](./index.md) (immutable) of a [Request](../-request/index.md) or [Response](../-response/index.md). + +### Properties + +| Name | Summary | +|---|---| +| [size](size.md) | `abstract val size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns the number of headers (key / value combinations). | + +### Functions + +| Name | Summary | +|---|---| +| [contains](contains.md) | `abstract operator fun contains(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)
Returns true if a [Header](../-header/index.md) with the given [name](contains.md#mozilla.components.concept.fetch.Headers$contains(kotlin.String)/name) exists. | +| [get](get.md) | `abstract operator fun get(index: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Header`](../-header/index.md)
Gets the [Header](../-header/index.md) at the specified [index](get.md#mozilla.components.concept.fetch.Headers$get(kotlin.Int)/index).`abstract operator fun get(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)`?`
Returns the last values corresponding to the specified header field name. Or null if the header does not exist. | +| [getAll](get-all.md) | `abstract fun getAll(name: `[`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)`>`
Returns the list of values corresponding to the specified header field name. | +| [set](set.md) | `abstract operator fun set(index: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, header: `[`Header`](../-header/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Sets the [Header](../-header/index.md) at the specified [index](set.md#mozilla.components.concept.fetch.Headers$set(kotlin.Int, mozilla.components.concept.fetch.Header)/index). | + +### Inheritors + +| Name | Summary | +|---|---| +| [MutableHeaders](../-mutable-headers/index.md) | `class MutableHeaders : `[`Headers`](./index.md)`, `[`MutableIterable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-iterable/index.html)`<`[`Header`](../-header/index.md)`>`
A collection of HTTP [Headers](./index.md) (mutable) of a [Request](../-request/index.md) or [Response](../-response/index.md). | diff --git a/docs/api/mozilla.components.concept.fetch/-headers/set.md b/docs/api/mozilla.components.concept.fetch/-headers/set.md new file mode 100644 index 00000000000..a4b32c591bd --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-headers/set.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Headers](index.md) / [set](./set.md) + +# set + +`abstract operator fun set(index: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, header: `[`Header`](../-header/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L36) + +Sets the [Header](../-header/index.md) at the specified [index](set.md#mozilla.components.concept.fetch.Headers$set(kotlin.Int, mozilla.components.concept.fetch.Header)/index). + diff --git a/docs/api/mozilla.components.concept.fetch/-headers/size.md b/docs/api/mozilla.components.concept.fetch/-headers/size.md new file mode 100644 index 00000000000..a8284b1a56a --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-headers/size.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Headers](index.md) / [size](./size.md) + +# size + +`abstract val size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L16) + +Returns the number of headers (key / value combinations). + diff --git a/docs/api/mozilla.components.concept.fetch/-mutable-headers/-init-.md b/docs/api/mozilla.components.concept.fetch/-mutable-headers/-init-.md new file mode 100644 index 00000000000..f1879179ef1 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-mutable-headers/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [MutableHeaders](index.md) / [<init>](./-init-.md) + +# <init> + +`MutableHeaders(vararg pairs: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/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)`>)` + +A collection of HTTP [Headers](../-headers/index.md) (mutable) of a [Request](../-request/index.md) or [Response](../-response/index.md). + diff --git a/docs/api/mozilla.components.concept.fetch/-mutable-headers/append.md b/docs/api/mozilla.components.concept.fetch/-mutable-headers/append.md new file mode 100644 index 00000000000..ddb7f3b51cb --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-mutable-headers/append.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [MutableHeaders](index.md) / [append](./append.md) + +# append + +`fun append(name: `[`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)`): `[`MutableHeaders`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L111) + +Append a header without removing the headers already present. + diff --git a/docs/api/mozilla.components.concept.fetch/-mutable-headers/contains.md b/docs/api/mozilla.components.concept.fetch/-mutable-headers/contains.md new file mode 100644 index 00000000000..da5a58c35b1 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-mutable-headers/contains.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [MutableHeaders](index.md) / [contains](./contains.md) + +# contains + +`operator fun contains(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L100) + +Overrides [Headers.contains](../-headers/contains.md) + +Returns true if a [Header](../-header/index.md) with the given [name](contains.md#mozilla.components.concept.fetch.MutableHeaders$contains(kotlin.String)/name) exists. + diff --git a/docs/api/mozilla.components.concept.fetch/-mutable-headers/get-all.md b/docs/api/mozilla.components.concept.fetch/-mutable-headers/get-all.md new file mode 100644 index 00000000000..89dadb7318a --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-mutable-headers/get-all.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [MutableHeaders](index.md) / [getAll](./get-all.md) + +# getAll + +`fun getAll(name: `[`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)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L81) + +Overrides [Headers.getAll](../-headers/get-all.md) + +Returns the list of values corresponding to the specified header field name. + diff --git a/docs/api/mozilla.components.concept.fetch/-mutable-headers/get.md b/docs/api/mozilla.components.concept.fetch/-mutable-headers/get.md new file mode 100644 index 00000000000..0e0c4777243 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-mutable-headers/get.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [MutableHeaders](index.md) / [get](./get.md) + +# get + +`fun get(index: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Header`](../-header/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L71) + +Overrides [Headers.get](../-headers/get.md) + +Gets the [Header](../-header/index.md) at the specified [index](get.md#mozilla.components.concept.fetch.MutableHeaders$get(kotlin.Int)/index). + +`fun get(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)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L76) + +Overrides [Headers.get](../-headers/get.md) + +Returns the last value corresponding to the specified header field name. Or null if the header does not exist. + diff --git a/docs/api/mozilla.components.concept.fetch/-mutable-headers/index.md b/docs/api/mozilla.components.concept.fetch/-mutable-headers/index.md new file mode 100644 index 00000000000..c092b3e7e05 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-mutable-headers/index.md @@ -0,0 +1,30 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [MutableHeaders](./index.md) + +# MutableHeaders + +`class MutableHeaders : `[`Headers`](../-headers/index.md)`, `[`MutableIterable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-iterable/index.html)`<`[`Header`](../-header/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L61) + +A collection of HTTP [Headers](../-headers/index.md) (mutable) of a [Request](../-request/index.md) or [Response](../-response/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `MutableHeaders(vararg pairs: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/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)`>)`
A collection of HTTP [Headers](../-headers/index.md) (mutable) of a [Request](../-request/index.md) or [Response](../-response/index.md). | + +### Properties + +| Name | Summary | +|---|---| +| [size](size.md) | `val size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns the number of headers (key / value combinations). | + +### Functions + +| Name | Summary | +|---|---| +| [append](append.md) | `fun append(name: `[`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)`): `[`MutableHeaders`](./index.md)
Append a header without removing the headers already present. | +| [contains](contains.md) | `operator fun contains(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)
Returns true if a [Header](../-header/index.md) with the given [name](contains.md#mozilla.components.concept.fetch.MutableHeaders$contains(kotlin.String)/name) exists. | +| [get](get.md) | `fun get(index: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`Header`](../-header/index.md)
Gets the [Header](../-header/index.md) at the specified [index](get.md#mozilla.components.concept.fetch.MutableHeaders$get(kotlin.Int)/index).`fun get(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)`?`
Returns the last value corresponding to the specified header field name. Or null if the header does not exist. | +| [getAll](get-all.md) | `fun getAll(name: `[`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)`>`
Returns the list of values corresponding to the specified header field name. | +| [iterator](iterator.md) | `fun iterator(): `[`MutableIterator`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-iterator/index.html)`<`[`Header`](../-header/index.md)`>`
Returns an iterator over the headers that supports removing elements during iteration. | +| [set](set.md) | `fun set(index: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, header: `[`Header`](../-header/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Sets the [Header](../-header/index.md) at the specified [index](set.md#mozilla.components.concept.fetch.MutableHeaders$set(kotlin.Int, mozilla.components.concept.fetch.Header)/index).`fun set(name: `[`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)`): `[`MutableHeaders`](./index.md)
Set the only occurrence of the header; potentially overriding an already existing header. | diff --git a/docs/api/mozilla.components.concept.fetch/-mutable-headers/iterator.md b/docs/api/mozilla.components.concept.fetch/-mutable-headers/iterator.md new file mode 100644 index 00000000000..310af4e688d --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-mutable-headers/iterator.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [MutableHeaders](index.md) / [iterator](./iterator.md) + +# iterator + +`fun iterator(): `[`MutableIterator`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-iterator/index.html)`<`[`Header`](../-header/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L95) + +Returns an iterator over the headers that supports removing elements during iteration. + diff --git a/docs/api/mozilla.components.concept.fetch/-mutable-headers/set.md b/docs/api/mozilla.components.concept.fetch/-mutable-headers/set.md new file mode 100644 index 00000000000..e6280951b0d --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-mutable-headers/set.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [MutableHeaders](index.md) / [set](./set.md) + +# set + +`fun set(index: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, header: `[`Header`](../-header/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L88) + +Overrides [Headers.set](../-headers/set.md) + +Sets the [Header](../-header/index.md) at the specified [index](set.md#mozilla.components.concept.fetch.MutableHeaders$set(kotlin.Int, mozilla.components.concept.fetch.Header)/index). + +`fun set(name: `[`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)`): `[`MutableHeaders`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L119) + +Set the only occurrence of the header; potentially overriding an already existing header. + diff --git a/docs/api/mozilla.components.concept.fetch/-mutable-headers/size.md b/docs/api/mozilla.components.concept.fetch/-mutable-headers/size.md new file mode 100644 index 00000000000..fcd3b831716 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-mutable-headers/size.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [MutableHeaders](index.md) / [size](./size.md) + +# size + +`val size: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Headers.kt#L105) + +Overrides [Headers.size](../-headers/size.md) + +Returns the number of headers (key / value combinations). + diff --git a/docs/api/mozilla.components.concept.fetch/-request/-body/-init-.md b/docs/api/mozilla.components.concept.fetch/-request/-body/-init-.md new file mode 100644 index 00000000000..66998ef2430 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-body/-init-.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Body](index.md) / [<init>](./-init-.md) + +# <init> + +`Body(stream: `[`InputStream`](https://developer.android.com/reference/java/io/InputStream.html)`)` + +A [Body](index.md) to be send with the [Request](../index.md). + +### Parameters + +`stream` - A stream that will be read and send to the resource. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-request/-body/close.md b/docs/api/mozilla.components.concept.fetch/-request/-body/close.md new file mode 100644 index 00000000000..1437bf7fcc3 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-body/close.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Body](index.md) / [close](./close.md) + +# close + +`fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L71) + +Closes this body and releases any system resources associated with it. + diff --git a/docs/api/mozilla.components.concept.fetch/-request/-body/from-file.md b/docs/api/mozilla.components.concept.fetch/-request/-body/from-file.md new file mode 100644 index 00000000000..6779672757e --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-body/from-file.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Body](index.md) / [fromFile](./from-file.md) + +# fromFile + +`fun fromFile(file: `[`File`](https://developer.android.com/reference/java/io/File.html)`): `[`Body`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L57) + +Create a [Body](index.md) from the provided [File](https://developer.android.com/reference/java/io/File.html). + diff --git a/docs/api/mozilla.components.concept.fetch/-request/-body/from-string.md b/docs/api/mozilla.components.concept.fetch/-request/-body/from-string.md new file mode 100644 index 00000000000..ea046b3fa6b --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-body/from-string.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Body](index.md) / [fromString](./from-string.md) + +# fromString + +`fun fromString(value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Body`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L52) + +Create a [Body](index.md) from the provided [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html). + diff --git a/docs/api/mozilla.components.concept.fetch/-request/-body/index.md b/docs/api/mozilla.components.concept.fetch/-request/-body/index.md new file mode 100644 index 00000000000..58e75a73da4 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-body/index.md @@ -0,0 +1,31 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Body](./index.md) + +# Body + +`class Body : `[`Closeable`](https://developer.android.com/reference/java/io/Closeable.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L45) + +A [Body](./index.md) to be send with the [Request](../index.md). + +### Parameters + +`stream` - A stream that will be read and send to the resource. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Body(stream: `[`InputStream`](https://developer.android.com/reference/java/io/InputStream.html)`)`
A [Body](./index.md) to be send with the [Request](../index.md). | + +### Functions + +| Name | Summary | +|---|---| +| [close](close.md) | `fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Closes this body and releases any system resources associated with it. | +| [useStream](use-stream.md) | `fun useStream(block: (`[`InputStream`](https://developer.android.com/reference/java/io/InputStream.html)`) -> `[`R`](use-stream.md#R)`): `[`R`](use-stream.md#R)
Executes the given [block](use-stream.md#mozilla.components.concept.fetch.Request.Body$useStream(kotlin.Function1((java.io.InputStream, mozilla.components.concept.fetch.Request.Body.useStream.R)))/block) function on the body's stream and then closes it down correctly whether an exception is thrown or not. | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [fromFile](from-file.md) | `fun fromFile(file: `[`File`](https://developer.android.com/reference/java/io/File.html)`): `[`Body`](./index.md)
Create a [Body](./index.md) from the provided [File](https://developer.android.com/reference/java/io/File.html). | +| [fromString](from-string.md) | `fun fromString(value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Body`](./index.md)
Create a [Body](./index.md) from the provided [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html). | diff --git a/docs/api/mozilla.components.concept.fetch/-request/-body/use-stream.md b/docs/api/mozilla.components.concept.fetch/-request/-body/use-stream.md new file mode 100644 index 00000000000..6f9a96ae0d0 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-body/use-stream.md @@ -0,0 +1,9 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Body](index.md) / [useStream](./use-stream.md) + +# useStream + +`fun useStream(block: (`[`InputStream`](https://developer.android.com/reference/java/io/InputStream.html)`) -> `[`R`](use-stream.md#R)`): `[`R`](use-stream.md#R) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L64) + +Executes the given [block](use-stream.md#mozilla.components.concept.fetch.Request.Body$useStream(kotlin.Function1((java.io.InputStream, mozilla.components.concept.fetch.Request.Body.useStream.R)))/block) function on the body's stream and then closes it down correctly whether an +exception is thrown or not. + diff --git a/docs/api/mozilla.components.concept.fetch/-request/-init-.md b/docs/api/mozilla.components.concept.fetch/-request/-init-.md new file mode 100644 index 00000000000..3694e530e24 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-init-.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Request](index.md) / [<init>](./-init-.md) + +# <init> + +`Request(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, method: `[`Method`](-method/index.md)` = Method.GET, headers: `[`MutableHeaders`](../-mutable-headers/index.md)`? = MutableHeaders(), connectTimeout: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)`>? = null, readTimeout: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)`>? = null, body: `[`Body`](-body/index.md)`? = null, redirect: `[`Redirect`](-redirect/index.md)` = Redirect.FOLLOW)` + +The [Request](index.md) data class represents a resource request to be send by a [Client](../-client/index.md). + +It's API is inspired by the Request interface of the Web Fetch API: +https://developer.mozilla.org/en-US/docs/Web/API/Request + diff --git a/docs/api/mozilla.components.concept.fetch/-request/-method/-c-o-n-n-e-c-t.md b/docs/api/mozilla.components.concept.fetch/-request/-method/-c-o-n-n-e-c-t.md new file mode 100644 index 00000000000..e7b402ec6ea --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-method/-c-o-n-n-e-c-t.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Method](index.md) / [CONNECT](./-c-o-n-n-e-c-t.md) + +# CONNECT + +`CONNECT` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L95) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-request/-method/-d-e-l-e-t-e.md b/docs/api/mozilla.components.concept.fetch/-request/-method/-d-e-l-e-t-e.md new file mode 100644 index 00000000000..e0afd42201d --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-method/-d-e-l-e-t-e.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Method](index.md) / [DELETE](./-d-e-l-e-t-e.md) + +# DELETE + +`DELETE` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L94) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-request/-method/-g-e-t.md b/docs/api/mozilla.components.concept.fetch/-request/-method/-g-e-t.md new file mode 100644 index 00000000000..3b473b6bd0e --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-method/-g-e-t.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Method](index.md) / [GET](./-g-e-t.md) + +# GET + +`GET` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L90) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-request/-method/-h-e-a-d.md b/docs/api/mozilla.components.concept.fetch/-request/-method/-h-e-a-d.md new file mode 100644 index 00000000000..96e59cb3ec8 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-method/-h-e-a-d.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Method](index.md) / [HEAD](./-h-e-a-d.md) + +# HEAD + +`HEAD` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L91) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-request/-method/-o-p-t-i-o-n-s.md b/docs/api/mozilla.components.concept.fetch/-request/-method/-o-p-t-i-o-n-s.md new file mode 100644 index 00000000000..6cb58c1cd7e --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-method/-o-p-t-i-o-n-s.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Method](index.md) / [OPTIONS](./-o-p-t-i-o-n-s.md) + +# OPTIONS + +`OPTIONS` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L96) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-request/-method/-p-o-s-t.md b/docs/api/mozilla.components.concept.fetch/-request/-method/-p-o-s-t.md new file mode 100644 index 00000000000..7f6615ef4fc --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-method/-p-o-s-t.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Method](index.md) / [POST](./-p-o-s-t.md) + +# POST + +`POST` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L92) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-request/-method/-p-u-t.md b/docs/api/mozilla.components.concept.fetch/-request/-method/-p-u-t.md new file mode 100644 index 00000000000..ddc8cf4a793 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-method/-p-u-t.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Method](index.md) / [PUT](./-p-u-t.md) + +# PUT + +`PUT` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L93) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-request/-method/-t-r-a-c-e.md b/docs/api/mozilla.components.concept.fetch/-request/-method/-t-r-a-c-e.md new file mode 100644 index 00000000000..0be60e7c2e7 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-method/-t-r-a-c-e.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Method](index.md) / [TRACE](./-t-r-a-c-e.md) + +# TRACE + +`TRACE` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L97) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-request/-method/index.md b/docs/api/mozilla.components.concept.fetch/-request/-method/index.md new file mode 100644 index 00000000000..9d3170ae0f4 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-method/index.md @@ -0,0 +1,26 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Method](./index.md) + +# Method + +`enum class Method` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L89) + +Request methods. + +The request method token is the primary source of request semantics; +it indicates the purpose for which the client has made this request +and what is expected by the client as a successful result. + +https://tools.ietf.org/html/rfc7231#section-4 + +### Enum Values + +| Name | Summary | +|---|---| +| [GET](-g-e-t.md) | | +| [HEAD](-h-e-a-d.md) | | +| [POST](-p-o-s-t.md) | | +| [PUT](-p-u-t.md) | | +| [DELETE](-d-e-l-e-t-e.md) | | +| [CONNECT](-c-o-n-n-e-c-t.md) | | +| [OPTIONS](-o-p-t-i-o-n-s.md) | | +| [TRACE](-t-r-a-c-e.md) | | diff --git a/docs/api/mozilla.components.concept.fetch/-request/-redirect/-f-o-l-l-o-w.md b/docs/api/mozilla.components.concept.fetch/-request/-redirect/-f-o-l-l-o-w.md new file mode 100644 index 00000000000..7d407d15bf6 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-redirect/-f-o-l-l-o-w.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Redirect](index.md) / [FOLLOW](./-f-o-l-l-o-w.md) + +# FOLLOW + +`FOLLOW` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L104) + +Automatically follow redirects. + diff --git a/docs/api/mozilla.components.concept.fetch/-request/-redirect/-m-a-n-u-a-l.md b/docs/api/mozilla.components.concept.fetch/-request/-redirect/-m-a-n-u-a-l.md new file mode 100644 index 00000000000..67ff1b97114 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-redirect/-m-a-n-u-a-l.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Redirect](index.md) / [MANUAL](./-m-a-n-u-a-l.md) + +# MANUAL + +`MANUAL` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L109) + +Do not follow redirects and let caller handle them manually. + diff --git a/docs/api/mozilla.components.concept.fetch/-request/-redirect/index.md b/docs/api/mozilla.components.concept.fetch/-request/-redirect/index.md new file mode 100644 index 00000000000..cab0652d381 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/-redirect/index.md @@ -0,0 +1,12 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Request](../index.md) / [Redirect](./index.md) + +# Redirect + +`enum class Redirect` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L100) + +### Enum Values + +| Name | Summary | +|---|---| +| [FOLLOW](-f-o-l-l-o-w.md) | Automatically follow redirects. | +| [MANUAL](-m-a-n-u-a-l.md) | Do not follow redirects and let caller handle them manually. | diff --git a/docs/api/mozilla.components.concept.fetch/-request/body.md b/docs/api/mozilla.components.concept.fetch/-request/body.md new file mode 100644 index 00000000000..bf9e2341364 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/body.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Request](index.md) / [body](./body.md) + +# body + +`val body: `[`Body`](-body/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L37) + +An optional body to be send with the request. + +### Property + +`body` - An optional body to be send with the request. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-request/connect-timeout.md b/docs/api/mozilla.components.concept.fetch/-request/connect-timeout.md new file mode 100644 index 00000000000..22876642269 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/connect-timeout.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Request](index.md) / [connectTimeout](./connect-timeout.md) + +# connectTimeout + +`val connectTimeout: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)`>?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L35) + +A timeout to be used when connecting to the resource. If the timeout expires before the +connection can be established, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an +infinite timeout. + +### Property + +`connectTimeout` - A timeout to be used when connecting to the resource. If the timeout expires before the +connection can be established, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an +infinite timeout. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-request/headers.md b/docs/api/mozilla.components.concept.fetch/-request/headers.md new file mode 100644 index 00000000000..54154ce02c8 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/headers.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Request](index.md) / [headers](./headers.md) + +# headers + +`val headers: `[`MutableHeaders`](../-mutable-headers/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L34) + +Optional HTTP headers to be send with the request. + +### Property + +`headers` - Optional HTTP headers to be send with the request. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-request/index.md b/docs/api/mozilla.components.concept.fetch/-request/index.md new file mode 100644 index 00000000000..f19697bb614 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/index.md @@ -0,0 +1,36 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Request](./index.md) + +# Request + +`data class Request` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L31) + +The [Request](./index.md) data class represents a resource request to be send by a [Client](../-client/index.md). + +It's API is inspired by the Request interface of the Web Fetch API: +https://developer.mozilla.org/en-US/docs/Web/API/Request + +### Types + +| Name | Summary | +|---|---| +| [Body](-body/index.md) | `class Body : `[`Closeable`](https://developer.android.com/reference/java/io/Closeable.html)
A [Body](-body/index.md) to be send with the [Request](./index.md). | +| [Method](-method/index.md) | `enum class Method`
Request methods. | +| [Redirect](-redirect/index.md) | `enum class Redirect` | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Request(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, method: `[`Method`](-method/index.md)` = Method.GET, headers: `[`MutableHeaders`](../-mutable-headers/index.md)`? = MutableHeaders(), connectTimeout: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)`>? = null, readTimeout: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)`>? = null, body: `[`Body`](-body/index.md)`? = null, redirect: `[`Redirect`](-redirect/index.md)` = Redirect.FOLLOW)`
The [Request](./index.md) data class represents a resource request to be send by a [Client](../-client/index.md). | + +### Properties + +| Name | Summary | +|---|---| +| [body](body.md) | `val body: `[`Body`](-body/index.md)`?`
An optional body to be send with the request. | +| [connectTimeout](connect-timeout.md) | `val connectTimeout: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)`>?`
A timeout to be used when connecting to the resource. If the timeout expires before the connection can be established, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite timeout. | +| [headers](headers.md) | `val headers: `[`MutableHeaders`](../-mutable-headers/index.md)`?`
Optional HTTP headers to be send with the request. | +| [method](method.md) | `val method: `[`Method`](-method/index.md)
The request method (GET, POST, ..) | +| [readTimeout](read-timeout.md) | `val readTimeout: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)`>?`
A timeout to be used when reading from the resource. If the timeout expires before there is data available for read, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite timeout. | +| [redirect](redirect.md) | `val redirect: `[`Redirect`](-redirect/index.md)
Whether the [Client](../-client/index.md) should follow redirects (HTTP 3xx) for this request or not. | +| [url](url.md) | `val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The URL of the request. | diff --git a/docs/api/mozilla.components.concept.fetch/-request/method.md b/docs/api/mozilla.components.concept.fetch/-request/method.md new file mode 100644 index 00000000000..43698cdc20d --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/method.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Request](index.md) / [method](./method.md) + +# method + +`val method: `[`Method`](-method/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L33) + +The request method (GET, POST, ..) + +### Property + +`method` - The request method (GET, POST, ..) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-request/read-timeout.md b/docs/api/mozilla.components.concept.fetch/-request/read-timeout.md new file mode 100644 index 00000000000..76260dad37d --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/read-timeout.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Request](index.md) / [readTimeout](./read-timeout.md) + +# readTimeout + +`val readTimeout: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)`>?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L36) + +A timeout to be used when reading from the resource. If the timeout expires before there is +data available for read, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite +timeout. + +### Property + +`readTimeout` - A timeout to be used when reading from the resource. If the timeout expires before there is +data available for read, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite +timeout. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-request/redirect.md b/docs/api/mozilla.components.concept.fetch/-request/redirect.md new file mode 100644 index 00000000000..91fb54624f6 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/redirect.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Request](index.md) / [redirect](./redirect.md) + +# redirect + +`val redirect: `[`Redirect`](-redirect/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L38) + +Whether the [Client](../-client/index.md) should follow redirects (HTTP 3xx) for this request or not. + +### Property + +`redirect` - Whether the [Client](../-client/index.md) should follow redirects (HTTP 3xx) for this request or not. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-request/url.md b/docs/api/mozilla.components.concept.fetch/-request/url.md new file mode 100644 index 00000000000..6f74ca8e1db --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-request/url.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Request](index.md) / [url](./url.md) + +# url + +`val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Request.kt#L32) + +The URL of the request. + +### Property + +`url` - The URL of the request. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-response/-body/-init-.md b/docs/api/mozilla.components.concept.fetch/-response/-body/-init-.md new file mode 100644 index 00000000000..9b811c9faa7 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-response/-body/-init-.md @@ -0,0 +1,10 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Response](../index.md) / [Body](index.md) / [<init>](./-init-.md) + +# <init> + +`Body(stream: `[`InputStream`](https://developer.android.com/reference/java/io/InputStream.html)`)` + +A [Body](index.md) returned along with the [Request](../../-request/index.md). + +**The response body can be consumed only once.**. + diff --git a/docs/api/mozilla.components.concept.fetch/-response/-body/close.md b/docs/api/mozilla.components.concept.fetch/-response/-body/close.md new file mode 100644 index 00000000000..6c1be1891a8 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-response/-body/close.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Response](../index.md) / [Body](index.md) / [close](./close.md) + +# close + +`open fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Response.kt#L81) + +Closes this [Body](index.md) and releases any system resources associated with it. + diff --git a/docs/api/mozilla.components.concept.fetch/-response/-body/empty.md b/docs/api/mozilla.components.concept.fetch/-response/-body/empty.md new file mode 100644 index 00000000000..f0bd51a338a --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-response/-body/empty.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Response](../index.md) / [Body](index.md) / [empty](./empty.md) + +# empty + +`fun empty(): `[`Body`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Response.kt#L93) + +Creates an empty response body. + diff --git a/docs/api/mozilla.components.concept.fetch/-response/-body/index.md b/docs/api/mozilla.components.concept.fetch/-response/-body/index.md new file mode 100644 index 00000000000..fa8ecef7b6d --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-response/-body/index.md @@ -0,0 +1,30 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Response](../index.md) / [Body](./index.md) + +# Body + +`class Body : `[`Closeable`](https://developer.android.com/reference/java/io/Closeable.html)`, `[`AutoCloseable`](https://developer.android.com/reference/java/lang/AutoCloseable.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Response.kt#L48) + +A [Body](./index.md) returned along with the [Request](../../-request/index.md). + +**The response body can be consumed only once.**. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Body(stream: `[`InputStream`](https://developer.android.com/reference/java/io/InputStream.html)`)`
A [Body](./index.md) returned along with the [Request](../../-request/index.md). | + +### Functions + +| Name | Summary | +|---|---| +| [close](close.md) | `open fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Closes this [Body](./index.md) and releases any system resources associated with it. | +| [string](string.md) | `fun string(charset: `[`Charset`](https://developer.android.com/reference/java/nio/charset/Charset.html)` = Charsets.UTF_8): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Reads this body completely as a String. | +| [useBufferedReader](use-buffered-reader.md) | `fun useBufferedReader(charset: `[`Charset`](https://developer.android.com/reference/java/nio/charset/Charset.html)` = Charsets.UTF_8, block: (`[`BufferedReader`](https://developer.android.com/reference/java/io/BufferedReader.html)`) -> `[`R`](use-buffered-reader.md#R)`): `[`R`](use-buffered-reader.md#R)
Creates a buffered reader from this body. | +| [useStream](use-stream.md) | `fun useStream(block: (`[`InputStream`](https://developer.android.com/reference/java/io/InputStream.html)`) -> `[`R`](use-stream.md#R)`): `[`R`](use-stream.md#R)
Creates a usable stream from this body. | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [empty](empty.md) | `fun empty(): `[`Body`](./index.md)
Creates an empty response body. | diff --git a/docs/api/mozilla.components.concept.fetch/-response/-body/string.md b/docs/api/mozilla.components.concept.fetch/-response/-body/string.md new file mode 100644 index 00000000000..a383de2a278 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-response/-body/string.md @@ -0,0 +1,10 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Response](../index.md) / [Body](index.md) / [string](./string.md) + +# string + +`fun string(charset: `[`Charset`](https://developer.android.com/reference/java/nio/charset/Charset.html)` = Charsets.UTF_8): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Response.kt#L76) + +Reads this body completely as a String. + +Takes care of closing the body down correctly whether an exception is thrown or not. + diff --git a/docs/api/mozilla.components.concept.fetch/-response/-body/use-buffered-reader.md b/docs/api/mozilla.components.concept.fetch/-response/-body/use-buffered-reader.md new file mode 100644 index 00000000000..c07fc5505c5 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-response/-body/use-buffered-reader.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Response](../index.md) / [Body](index.md) / [useBufferedReader](./use-buffered-reader.md) + +# useBufferedReader + +`fun useBufferedReader(charset: `[`Charset`](https://developer.android.com/reference/java/nio/charset/Charset.html)` = Charsets.UTF_8, block: (`[`BufferedReader`](https://developer.android.com/reference/java/io/BufferedReader.html)`) -> `[`R`](use-buffered-reader.md#R)`): `[`R`](use-buffered-reader.md#R) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Response.kt#L67) + +Creates a buffered reader from this body. + +Executes the given [block](use-buffered-reader.md#mozilla.components.concept.fetch.Response.Body$useBufferedReader(java.nio.charset.Charset, kotlin.Function1((java.io.BufferedReader, mozilla.components.concept.fetch.Response.Body.useBufferedReader.R)))/block) function with the buffered reader as parameter and then closes it down correctly +whether an exception is thrown or not. + diff --git a/docs/api/mozilla.components.concept.fetch/-response/-body/use-stream.md b/docs/api/mozilla.components.concept.fetch/-response/-body/use-stream.md new file mode 100644 index 00000000000..fd5d44cc581 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-response/-body/use-stream.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.fetch](../../index.md) / [Response](../index.md) / [Body](index.md) / [useStream](./use-stream.md) + +# useStream + +`fun useStream(block: (`[`InputStream`](https://developer.android.com/reference/java/io/InputStream.html)`) -> `[`R`](use-stream.md#R)`): `[`R`](use-stream.md#R) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Response.kt#L57) + +Creates a usable stream from this body. + +Executes the given [block](use-stream.md#mozilla.components.concept.fetch.Response.Body$useStream(kotlin.Function1((java.io.InputStream, mozilla.components.concept.fetch.Response.Body.useStream.R)))/block) function with the stream as parameter and then closes it down correctly +whether an exception is thrown or not. + diff --git a/docs/api/mozilla.components.concept.fetch/-response/-init-.md b/docs/api/mozilla.components.concept.fetch/-response/-init-.md new file mode 100644 index 00000000000..2825cf05f98 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-response/-init-.md @@ -0,0 +1,22 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Response](index.md) / [<init>](./-init-.md) + +# <init> + +`Response(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, status: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, headers: `[`Headers`](../-headers/index.md)`, body: `[`Body`](-body/index.md)`)` + +The [Response](index.md) data class represents a reponse to a [Request](../-request/index.md) send by a [Client](../-client/index.md). + +You can create a [Response](index.md) object using the constructor, but you are more likely to encounter a [Response](index.md) object +being returned as the result of calling [Client.fetch](../-client/fetch.md). + +A [Response](index.md) may hold references to other resources (e.g. streams). Therefore it's important to always close the +[Response](index.md) object or its [Body](-body/index.md). This can be done by either consuming the content of the [Body](-body/index.md) with one of the +available methods or by using Kotlin's extension methods for using [Closeable](https://developer.android.com/reference/java/io/Closeable.html) implementations (like `use()`): + +``` Kotlin +val response = ... +response.use { + // Use response. Resources will get released automatically at the end of the block. +} +``` + diff --git a/docs/api/mozilla.components.concept.fetch/-response/body.md b/docs/api/mozilla.components.concept.fetch/-response/body.md new file mode 100644 index 00000000000..c3c3f7e1d55 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-response/body.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Response](index.md) / [body](./body.md) + +# body + +`val body: `[`Body`](-body/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Response.kt#L34) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-response/close.md b/docs/api/mozilla.components.concept.fetch/-response/close.md new file mode 100644 index 00000000000..7102d06d1c2 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-response/close.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Response](index.md) / [close](./close.md) + +# close + +`fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Response.kt#L39) + +Closes this [Response](index.md) and its [Body](-body/index.md) and releases any system resources associated with it. + diff --git a/docs/api/mozilla.components.concept.fetch/-response/headers.md b/docs/api/mozilla.components.concept.fetch/-response/headers.md new file mode 100644 index 00000000000..32578221bbd --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-response/headers.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Response](index.md) / [headers](./headers.md) + +# headers + +`val headers: `[`Headers`](../-headers/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Response.kt#L33) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-response/index.md b/docs/api/mozilla.components.concept.fetch/-response/index.md new file mode 100644 index 00000000000..c1afc7e4cab --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-response/index.md @@ -0,0 +1,55 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Response](./index.md) + +# Response + +`data class Response : `[`Closeable`](https://developer.android.com/reference/java/io/Closeable.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Response.kt#L30) + +The [Response](./index.md) data class represents a reponse to a [Request](../-request/index.md) send by a [Client](../-client/index.md). + +You can create a [Response](./index.md) object using the constructor, but you are more likely to encounter a [Response](./index.md) object +being returned as the result of calling [Client.fetch](../-client/fetch.md). + +A [Response](./index.md) may hold references to other resources (e.g. streams). Therefore it's important to always close the +[Response](./index.md) object or its [Body](-body/index.md). This can be done by either consuming the content of the [Body](-body/index.md) with one of the +available methods or by using Kotlin's extension methods for using [Closeable](https://developer.android.com/reference/java/io/Closeable.html) implementations (like `use()`): + +``` Kotlin +val response = ... +response.use { + // Use response. Resources will get released automatically at the end of the block. +} +``` + +### Types + +| Name | Summary | +|---|---| +| [Body](-body/index.md) | `class Body : `[`Closeable`](https://developer.android.com/reference/java/io/Closeable.html)`, `[`AutoCloseable`](https://developer.android.com/reference/java/lang/AutoCloseable.html)
A [Body](-body/index.md) returned along with the [Request](../-request/index.md). | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Response(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, status: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, headers: `[`Headers`](../-headers/index.md)`, body: `[`Body`](-body/index.md)`)`
The [Response](./index.md) data class represents a reponse to a [Request](../-request/index.md) send by a [Client](../-client/index.md). | + +### Properties + +| Name | Summary | +|---|---| +| [body](body.md) | `val body: `[`Body`](-body/index.md) | +| [headers](headers.md) | `val headers: `[`Headers`](../-headers/index.md) | +| [status](status.md) | `val status: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [url](url.md) | `val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [close](close.md) | `fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Closes this [Response](./index.md) and its [Body](-body/index.md) and releases any system resources associated with it. | + +### Extension Properties + +| Name | Summary | +|---|---| +| [clientError](../client-error.md) | `val `[`Response`](./index.md)`.clientError: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true if the response was a client error (status in the range 400-499) or false otherwise. | +| [success](../success.md) | `val `[`Response`](./index.md)`.success: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true if the response was successful (status in the range 200-299) or false otherwise. | diff --git a/docs/api/mozilla.components.concept.fetch/-response/status.md b/docs/api/mozilla.components.concept.fetch/-response/status.md new file mode 100644 index 00000000000..fbc5635b472 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-response/status.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Response](index.md) / [status](./status.md) + +# status + +`val status: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Response.kt#L32) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/-response/url.md b/docs/api/mozilla.components.concept.fetch/-response/url.md new file mode 100644 index 00000000000..5f16b48e2e1 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/-response/url.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.fetch](../index.md) / [Response](index.md) / [url](./url.md) + +# url + +`val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Response.kt#L31) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.fetch/client-error.md b/docs/api/mozilla.components.concept.fetch/client-error.md new file mode 100644 index 00000000000..6f27df3f473 --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/client-error.md @@ -0,0 +1,8 @@ +[android-components](../index.md) / [mozilla.components.concept.fetch](index.md) / [clientError](./client-error.md) + +# clientError + +`val `[`Response`](-response/index.md)`.clientError: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Response.kt#L109) + +Returns true if the response was a client error (status in the range 400-499) or false otherwise. + diff --git a/docs/api/mozilla.components.concept.fetch/index.md b/docs/api/mozilla.components.concept.fetch/index.md new file mode 100644 index 00000000000..c653a5bd1ba --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/index.md @@ -0,0 +1,21 @@ +[android-components](../index.md) / [mozilla.components.concept.fetch](./index.md) + +## Package mozilla.components.concept.fetch + +### Types + +| Name | Summary | +|---|---| +| [Client](-client/index.md) | `abstract class Client`
A generic [Client](-client/index.md) for fetching resources via HTTP/s. | +| [Header](-header/index.md) | `data class Header`
Represents a [Header](-header/index.md) containing of a [name](-header/name.md) and [value](-header/value.md). | +| [Headers](-headers/index.md) | `interface Headers : `[`Iterable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterable/index.html)`<`[`Header`](-header/index.md)`>`
A collection of HTTP [Headers](-headers/index.md) (immutable) of a [Request](-request/index.md) or [Response](-response/index.md). | +| [MutableHeaders](-mutable-headers/index.md) | `class MutableHeaders : `[`Headers`](-headers/index.md)`, `[`MutableIterable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-iterable/index.html)`<`[`Header`](-header/index.md)`>`
A collection of HTTP [Headers](-headers/index.md) (mutable) of a [Request](-request/index.md) or [Response](-response/index.md). | +| [Request](-request/index.md) | `data class Request`
The [Request](-request/index.md) data class represents a resource request to be send by a [Client](-client/index.md). | +| [Response](-response/index.md) | `data class Response : `[`Closeable`](https://developer.android.com/reference/java/io/Closeable.html)
The [Response](-response/index.md) data class represents a reponse to a [Request](-request/index.md) send by a [Client](-client/index.md). | + +### Properties + +| Name | Summary | +|---|---| +| [clientError](client-error.md) | `val `[`Response`](-response/index.md)`.clientError: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true if the response was a client error (status in the range 400-499) or false otherwise. | +| [success](success.md) | `val `[`Response`](-response/index.md)`.success: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true if the response was successful (status in the range 200-299) or false otherwise. | diff --git a/docs/api/mozilla.components.concept.fetch/success.md b/docs/api/mozilla.components.concept.fetch/success.md new file mode 100644 index 00000000000..7f50178606c --- /dev/null +++ b/docs/api/mozilla.components.concept.fetch/success.md @@ -0,0 +1,8 @@ +[android-components](../index.md) / [mozilla.components.concept.fetch](index.md) / [success](./success.md) + +# success + +`val `[`Response`](-response/index.md)`.success: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/fetch/src/main/java/mozilla/components/concept/fetch/Response.kt#L102) + +Returns true if the response was successful (status in the range 200-299) or false otherwise. + diff --git a/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/-init-.md b/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/-init-.md new file mode 100644 index 00000000000..673e3c6c78f --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [HistoryAutocompleteResult](index.md) / [<init>](./-init-.md) + +# <init> + +`HistoryAutocompleteResult(input: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, 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)`, totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` + +Describes an autocompletion result against history storage. + diff --git a/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/index.md b/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/index.md new file mode 100644 index 00000000000..be35470144f --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [HistoryAutocompleteResult](./index.md) + +# HistoryAutocompleteResult + +`data class HistoryAutocompleteResult` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L97) + +Describes an autocompletion result against history storage. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `HistoryAutocompleteResult(input: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, 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)`, totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)`
Describes an autocompletion result against history storage. | + +### Properties + +| Name | Summary | +|---|---| +| [input](input.md) | `val input: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Input for which this result is being provided. | +| [source](source.md) | `val source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Name of the autocompletion source. | +| [text](text.md) | `val text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Result of autocompletion, text to be displayed. | +| [totalItems](total-items.md) | `val totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
A total number of results also available. | +| [url](url.md) | `val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Result of autocompletion, full matching url. | diff --git a/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/input.md b/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/input.md new file mode 100644 index 00000000000..5fc733ff7d4 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/input.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [HistoryAutocompleteResult](index.md) / [input](./input.md) + +# input + +`val input: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L98) + +Input for which this result is being provided. + +### Property + +`input` - Input for which this result is being provided. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/source.md b/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/source.md new file mode 100644 index 00000000000..721e6042ad5 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/source.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [HistoryAutocompleteResult](index.md) / [source](./source.md) + +# source + +`val source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L101) + +Name of the autocompletion source. + +### Property + +`source` - Name of the autocompletion source. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/text.md b/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/text.md new file mode 100644 index 00000000000..a9e487392a6 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/text.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [HistoryAutocompleteResult](index.md) / [text](./text.md) + +# text + +`val text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L99) + +Result of autocompletion, text to be displayed. + +### Property + +`text` - Result of autocompletion, text to be displayed. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/total-items.md b/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/total-items.md new file mode 100644 index 00000000000..a65e95c67de --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/total-items.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [HistoryAutocompleteResult](index.md) / [totalItems](./total-items.md) + +# totalItems + +`val totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L102) + +A total number of results also available. + +### Property + +`totalItems` - A total number of results also available. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/url.md b/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/url.md new file mode 100644 index 00000000000..f8d3d9ad13f --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-history-autocomplete-result/url.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [HistoryAutocompleteResult](index.md) / [url](./url.md) + +# url + +`val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L100) + +Result of autocompletion, full matching url. + +### Property + +`url` - Result of autocompletion, full matching url. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.storage/-history-storage/cleanup.md b/docs/api/mozilla.components.concept.storage/-history-storage/cleanup.md new file mode 100644 index 00000000000..0c3b5532425 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-history-storage/cleanup.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [HistoryStorage](index.md) / [cleanup](./cleanup.md) + +# cleanup + +`abstract fun cleanup(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L56) + +Cleanup any allocated resources. + diff --git a/docs/api/mozilla.components.concept.storage/-history-storage/get-autocomplete-suggestion.md b/docs/api/mozilla.components.concept.storage/-history-storage/get-autocomplete-suggestion.md new file mode 100644 index 00000000000..029cde462f0 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-history-storage/get-autocomplete-suggestion.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [HistoryStorage](index.md) / [getAutocompleteSuggestion](./get-autocomplete-suggestion.md) + +# getAutocompleteSuggestion + +`abstract fun getAutocompleteSuggestion(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`HistoryAutocompleteResult`](../-history-autocomplete-result/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L51) + +Retrieves domain suggestions which best match the [query](get-autocomplete-suggestion.md#mozilla.components.concept.storage.HistoryStorage$getAutocompleteSuggestion(kotlin.String)/query). + +### Parameters + +`query` - A query by which to search the underlying store. + +**Return** +An optional domain URL which best matches the query. + diff --git a/docs/api/mozilla.components.concept.storage/-history-storage/get-suggestions.md b/docs/api/mozilla.components.concept.storage/-history-storage/get-suggestions.md new file mode 100644 index 00000000000..54ee386caff --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-history-storage/get-suggestions.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [HistoryStorage](index.md) / [getSuggestions](./get-suggestions.md) + +# getSuggestions + +`abstract fun getSuggestions(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, limit: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchResult`](../-search-result/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L44) + +Retrieves suggestions matching the [query](get-suggestions.md#mozilla.components.concept.storage.HistoryStorage$getSuggestions(kotlin.String, kotlin.Int)/query). + +### Parameters + +`query` - A query by which to search the underlying store. + +**Return** +A List of [SearchResult](../-search-result/index.md) matching the query, in no particular order. + diff --git a/docs/api/mozilla.components.concept.storage/-history-storage/get-visited.md b/docs/api/mozilla.components.concept.storage/-history-storage/get-visited.md new file mode 100644 index 00000000000..9ea3246c03b --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-history-storage/get-visited.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [HistoryStorage](index.md) / [getVisited](./get-visited.md) + +# getVisited + +`abstract suspend fun getVisited(uris: `[`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`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L31) + +Maps a list of page URIs to a list of booleans indicating if each URI was visited. + +### Parameters + +`uris` - a list of page URIs about which "visited" information is being requested. + +**Return** +A list of booleans indicating visited status of each +corresponding page URI from [uris](get-visited.md#mozilla.components.concept.storage.HistoryStorage$getVisited(kotlin.collections.List((kotlin.String)))/uris). + +`abstract suspend fun getVisited(): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L37) + +Retrieves a list of all visited pages. + +**Return** +A list of all visited page URIs. + diff --git a/docs/api/mozilla.components.concept.storage/-history-storage/index.md b/docs/api/mozilla.components.concept.storage/-history-storage/index.md new file mode 100644 index 00000000000..389869ce461 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-history-storage/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [HistoryStorage](./index.md) + +# HistoryStorage + +`interface HistoryStorage` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L10) + +An interface which defines read/write methods for history data. + +### Functions + +| Name | Summary | +|---|---| +| [cleanup](cleanup.md) | `abstract fun cleanup(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Cleanup any allocated resources. | +| [getAutocompleteSuggestion](get-autocomplete-suggestion.md) | `abstract fun getAutocompleteSuggestion(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`HistoryAutocompleteResult`](../-history-autocomplete-result/index.md)`?`
Retrieves domain suggestions which best match the [query](get-autocomplete-suggestion.md#mozilla.components.concept.storage.HistoryStorage$getAutocompleteSuggestion(kotlin.String)/query). | +| [getSuggestions](get-suggestions.md) | `abstract fun getSuggestions(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, limit: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SearchResult`](../-search-result/index.md)`>`
Retrieves suggestions matching the [query](get-suggestions.md#mozilla.components.concept.storage.HistoryStorage$getSuggestions(kotlin.String, kotlin.Int)/query). | +| [getVisited](get-visited.md) | `abstract suspend fun getVisited(uris: `[`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`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>`
Maps a list of page URIs to a list of booleans indicating if each URI was visited.`abstract suspend fun getVisited(): `[`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)`>`
Retrieves a list of all visited pages. | +| [recordObservation](record-observation.md) | `abstract suspend fun recordObservation(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, observation: `[`PageObservation`](../-page-observation/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Records an observation about a page. | +| [recordVisit](record-visit.md) | `abstract suspend fun recordVisit(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, visitType: `[`VisitType`](../-visit-type/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Records a visit to a page. | + +### Inheritors + +| Name | Summary | +|---|---| +| [InMemoryHistoryStorage](../../mozilla.components.browser.storage.memory/-in-memory-history-storage/index.md) | `class InMemoryHistoryStorage : `[`HistoryStorage`](./index.md)
An in-memory implementation of [mozilla.components.concept.storage.HistoryStorage](./index.md). | +| [PlacesHistoryStorage](../../mozilla.components.browser.storage.sync/-places-history-storage/index.md) | `open class PlacesHistoryStorage : `[`HistoryStorage`](./index.md)`, `[`SyncableStore`](../-syncable-store/index.md)``
Implementation of the [HistoryStorage](./index.md) which is backed by a Rust Places lib via [PlacesConnection](#). | diff --git a/docs/api/mozilla.components.concept.storage/-history-storage/record-observation.md b/docs/api/mozilla.components.concept.storage/-history-storage/record-observation.md new file mode 100644 index 00000000000..5e768e9e01b --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-history-storage/record-observation.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [HistoryStorage](index.md) / [recordObservation](./record-observation.md) + +# recordObservation + +`abstract suspend fun recordObservation(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, observation: `[`PageObservation`](../-page-observation/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L23) + +Records an observation about a page. + +### Parameters + +`uri` - of the page for which to record an observation. + +`observation` - a [PageObservation](../-page-observation/index.md) which encapsulates meta data observed about the page. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.storage/-history-storage/record-visit.md b/docs/api/mozilla.components.concept.storage/-history-storage/record-visit.md new file mode 100644 index 00000000000..92fa2c11cb1 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-history-storage/record-visit.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [HistoryStorage](index.md) / [recordVisit](./record-visit.md) + +# recordVisit + +`abstract suspend fun recordVisit(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, visitType: `[`VisitType`](../-visit-type/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L16) + +Records a visit to a page. + +### Parameters + +`uri` - of the page which was visited. + +`visitType` - type of the visit, see [VisitType](../-visit-type/index.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.storage/-page-observation/-init-.md b/docs/api/mozilla.components.concept.storage/-page-observation/-init-.md new file mode 100644 index 00000000000..faa0f372167 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-page-observation/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [PageObservation](index.md) / [<init>](./-init-.md) + +# <init> + +`PageObservation(title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?)` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.storage/-page-observation/index.md b/docs/api/mozilla.components.concept.storage/-page-observation/index.md new file mode 100644 index 00000000000..09173e0086c --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-page-observation/index.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [PageObservation](./index.md) + +# PageObservation + +`data class PageObservation` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L59) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `PageObservation(title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?)` | + +### Properties + +| Name | Summary | +|---|---| +| [title](title.md) | `val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | diff --git a/docs/api/mozilla.components.concept.storage/-page-observation/title.md b/docs/api/mozilla.components.concept.storage/-page-observation/title.md new file mode 100644 index 00000000000..59bdde5ad08 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-page-observation/title.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [PageObservation](index.md) / [title](./title.md) + +# title + +`val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L59) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.storage/-search-result/-init-.md b/docs/api/mozilla.components.concept.storage/-search-result/-init-.md new file mode 100644 index 00000000000..6d2b16e4109 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-search-result/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [SearchResult](index.md) / [<init>](./-init-.md) + +# <init> + +`SearchResult(id: `[`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)`, score: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)` + +Encapsulates a set of properties which define a result of querying history storage. + diff --git a/docs/api/mozilla.components.concept.storage/-search-result/id.md b/docs/api/mozilla.components.concept.storage/-search-result/id.md new file mode 100644 index 00000000000..5e7c8a056b4 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-search-result/id.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [SearchResult](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L83) + +A permanent identifier which might be used for caching or at the UI layer. + +### Property + +`id` - A permanent identifier which might be used for caching or at the UI layer. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.storage/-search-result/index.md b/docs/api/mozilla.components.concept.storage/-search-result/index.md new file mode 100644 index 00000000000..caf3fb423a4 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-search-result/index.md @@ -0,0 +1,22 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [SearchResult](./index.md) + +# SearchResult + +`data class SearchResult` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L82) + +Encapsulates a set of properties which define a result of querying history storage. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SearchResult(id: `[`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)`, score: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)`
Encapsulates a set of properties which define a result of querying history storage. | + +### Properties + +| Name | Summary | +|---|---| +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
A permanent identifier which might be used for caching or at the UI layer. | +| [score](score.md) | `val score: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
An unbounded, nonlinear score (larger is more relevant) which is used to rank this [SearchResult](./index.md) against others. | +| [title](title.md) | `val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
An optional title of the page. | +| [url](url.md) | `val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
A URL of the page. | diff --git a/docs/api/mozilla.components.concept.storage/-search-result/score.md b/docs/api/mozilla.components.concept.storage/-search-result/score.md new file mode 100644 index 00000000000..3ef965c426b --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-search-result/score.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [SearchResult](index.md) / [score](./score.md) + +# score + +`val score: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L85) + +An unbounded, nonlinear score (larger is more relevant) which is used to rank +this [SearchResult](index.md) against others. + +### Property + +`score` - An unbounded, nonlinear score (larger is more relevant) which is used to rank +this [SearchResult](index.md) against others. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.storage/-search-result/title.md b/docs/api/mozilla.components.concept.storage/-search-result/title.md new file mode 100644 index 00000000000..e8f04ab1f32 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-search-result/title.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [SearchResult](index.md) / [title](./title.md) + +# title + +`val title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L86) + +An optional title of the page. + +### Property + +`title` - An optional title of the page. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.storage/-search-result/url.md b/docs/api/mozilla.components.concept.storage/-search-result/url.md new file mode 100644 index 00000000000..7fe855af598 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-search-result/url.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [SearchResult](index.md) / [url](./url.md) + +# url + +`val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L84) + +A URL of the page. + +### Property + +`url` - A URL of the page. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.storage/-sync-error/-init-.md b/docs/api/mozilla.components.concept.storage/-sync-error/-init-.md new file mode 100644 index 00000000000..79a5932692a --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-sync-error/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [SyncError](index.md) / [<init>](./-init-.md) + +# <init> + +`SyncError(exception: `[`Exception`](https://developer.android.com/reference/java/lang/Exception.html)`)` \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.storage/-sync-error/exception.md b/docs/api/mozilla.components.concept.storage/-sync-error/exception.md new file mode 100644 index 00000000000..8abb830fb8f --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-sync-error/exception.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [SyncError](index.md) / [exception](./exception.md) + +# exception + +`val exception: `[`Exception`](https://developer.android.com/reference/java/lang/Exception.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/SyncableStore.kt#L23) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.storage/-sync-error/index.md b/docs/api/mozilla.components.concept.storage/-sync-error/index.md new file mode 100644 index 00000000000..b3ef243eac1 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-sync-error/index.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [SyncError](./index.md) + +# SyncError + +`data class SyncError : `[`SyncStatus`](../-sync-status.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/SyncableStore.kt#L23) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SyncError(exception: `[`Exception`](https://developer.android.com/reference/java/lang/Exception.html)`)` | + +### Properties + +| Name | Summary | +|---|---| +| [exception](exception.md) | `val exception: `[`Exception`](https://developer.android.com/reference/java/lang/Exception.html) | diff --git a/docs/api/mozilla.components.concept.storage/-sync-ok.md b/docs/api/mozilla.components.concept.storage/-sync-ok.md new file mode 100644 index 00000000000..b2af78a2fd4 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-sync-ok.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.concept.storage](index.md) / [SyncOk](./-sync-ok.md) + +# SyncOk + +`object SyncOk : `[`SyncStatus`](-sync-status.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/SyncableStore.kt#L22) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.storage/-sync-status.md b/docs/api/mozilla.components.concept.storage/-sync-status.md new file mode 100644 index 00000000000..e01a7a89f1a --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-sync-status.md @@ -0,0 +1,12 @@ +[android-components](../index.md) / [mozilla.components.concept.storage](index.md) / [SyncStatus](./-sync-status.md) + +# SyncStatus + +`sealed class SyncStatus` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/SyncableStore.kt#L21) + +### Inheritors + +| Name | Summary | +|---|---| +| [SyncError](-sync-error/index.md) | `data class SyncError : `[`SyncStatus`](./-sync-status.md) | +| [SyncOk](-sync-ok.md) | `object SyncOk : `[`SyncStatus`](./-sync-status.md) | diff --git a/docs/api/mozilla.components.concept.storage/-syncable-store/index.md b/docs/api/mozilla.components.concept.storage/-syncable-store/index.md new file mode 100644 index 00000000000..d82ac5458a6 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-syncable-store/index.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [SyncableStore](./index.md) + +# SyncableStore + +`interface SyncableStore` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/SyncableStore.kt#L12) + +Describes a "sync" entry point for store which operates over [AuthInfo](index.md#AuthInfo). + +### Functions + +| Name | Summary | +|---|---| +| [sync](sync.md) | `abstract suspend fun sync(authInfo: `[`AuthInfo`](index.md#AuthInfo)`): `[`SyncStatus`](../-sync-status.md)
Performs a sync. | + +### Inheritors + +| Name | Summary | +|---|---| +| [PlacesHistoryStorage](../../mozilla.components.browser.storage.sync/-places-history-storage/index.md) | `open class PlacesHistoryStorage : `[`HistoryStorage`](../-history-storage/index.md)`, `[`SyncableStore`](./index.md)``
Implementation of the [HistoryStorage](../-history-storage/index.md) which is backed by a Rust Places lib via [PlacesConnection](#). | +| [SyncableLoginsStore](../../mozilla.components.service.sync.logins/-syncable-logins-store/index.md) | `data class SyncableLoginsStore : `[`SyncableStore`](./index.md)`<`[`SyncUnlockInfo`](../../mozilla.components.service.sync.logins/-sync-unlock-info.md)`>`
Wraps [AsyncLoginsStorage](../../mozilla.components.service.sync.logins/-async-logins-storage/index.md) instance along with a lazy encryption key. | diff --git a/docs/api/mozilla.components.concept.storage/-syncable-store/sync.md b/docs/api/mozilla.components.concept.storage/-syncable-store/sync.md new file mode 100644 index 00000000000..9e68273403c --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-syncable-store/sync.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [SyncableStore](index.md) / [sync](./sync.md) + +# sync + +`abstract suspend fun sync(authInfo: `[`AuthInfo`](index.md#AuthInfo)`): `[`SyncStatus`](../-sync-status.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/SyncableStore.kt#L18) + +Performs a sync. + +### Parameters + +`authInfo` - Auth information of type [AuthInfo](index.md#AuthInfo) necessary for syncing this store. + +**Return** +[SyncStatus](../-sync-status.md) A status object describing how sync went. + diff --git a/docs/api/mozilla.components.concept.storage/-visit-type/-l-i-n-k.md b/docs/api/mozilla.components.concept.storage/-visit-type/-l-i-n-k.md new file mode 100644 index 00000000000..a2bbf902d66 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-visit-type/-l-i-n-k.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [VisitType](index.md) / [LINK](./-l-i-n-k.md) + +# LINK + +`LINK` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L67) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [type](type.md) | `val type: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.concept.storage/-visit-type/-r-e-l-o-a-d.md b/docs/api/mozilla.components.concept.storage/-visit-type/-r-e-l-o-a-d.md new file mode 100644 index 00000000000..b4f22a94b6a --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-visit-type/-r-e-l-o-a-d.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [VisitType](index.md) / [RELOAD](./-r-e-l-o-a-d.md) + +# RELOAD + +`RELOAD` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L70) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [type](type.md) | `val type: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.concept.storage/-visit-type/-t-y-p-e-d.md b/docs/api/mozilla.components.concept.storage/-visit-type/-t-y-p-e-d.md new file mode 100644 index 00000000000..768c385019f --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-visit-type/-t-y-p-e-d.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [VisitType](index.md) / [TYPED](./-t-y-p-e-d.md) + +# TYPED + +`TYPED` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L69) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [type](type.md) | `val type: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.concept.storage/-visit-type/index.md b/docs/api/mozilla.components.concept.storage/-visit-type/index.md new file mode 100644 index 00000000000..c47820c6486 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-visit-type/index.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [VisitType](./index.md) + +# VisitType + +`enum class VisitType` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L65) + +Visit type constants as defined by Desktop Firefox. + +### Enum Values + +| Name | Summary | +|---|---| +| [LINK](-l-i-n-k.md) | | +| [TYPED](-t-y-p-e-d.md) | | +| [RELOAD](-r-e-l-o-a-d.md) | | + +### Properties + +| Name | Summary | +|---|---| +| [type](type.md) | `val type: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.concept.storage/-visit-type/type.md b/docs/api/mozilla.components.concept.storage/-visit-type/type.md new file mode 100644 index 00000000000..a5ec4ab64cd --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/-visit-type/type.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.concept.storage](../index.md) / [VisitType](index.md) / [type](./type.md) + +# type + +`val type: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/storage/src/main/java/mozilla/components/concept/storage/HistoryStorage.kt#L65) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.storage/index.md b/docs/api/mozilla.components.concept.storage/index.md new file mode 100644 index 00000000000..55875ef8594 --- /dev/null +++ b/docs/api/mozilla.components.concept.storage/index.md @@ -0,0 +1,17 @@ +[android-components](../index.md) / [mozilla.components.concept.storage](./index.md) + +## Package mozilla.components.concept.storage + +### Types + +| Name | Summary | +|---|---| +| [HistoryAutocompleteResult](-history-autocomplete-result/index.md) | `data class HistoryAutocompleteResult`
Describes an autocompletion result against history storage. | +| [HistoryStorage](-history-storage/index.md) | `interface HistoryStorage`
An interface which defines read/write methods for history data. | +| [PageObservation](-page-observation/index.md) | `data class PageObservation` | +| [SearchResult](-search-result/index.md) | `data class SearchResult`
Encapsulates a set of properties which define a result of querying history storage. | +| [SyncError](-sync-error/index.md) | `data class SyncError : `[`SyncStatus`](-sync-status.md) | +| [SyncOk](-sync-ok.md) | `object SyncOk : `[`SyncStatus`](-sync-status.md) | +| [SyncStatus](-sync-status.md) | `sealed class SyncStatus` | +| [SyncableStore](-syncable-store/index.md) | `interface SyncableStore`
Describes a "sync" entry point for store which operates over [AuthInfo](-syncable-store/index.md#AuthInfo). | +| [VisitType](-visit-type/index.md) | `enum class VisitType`
Visit type constants as defined by Desktop Firefox. | diff --git a/docs/api/mozilla.components.concept.tabstray/-tabs-tray/-observer/index.md b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/-observer/index.md new file mode 100644 index 00000000000..a0ed93b3bc5 --- /dev/null +++ b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/-observer/index.md @@ -0,0 +1,20 @@ +[android-components](../../../index.md) / [mozilla.components.concept.tabstray](../../index.md) / [TabsTray](../index.md) / [Observer](./index.md) + +# Observer + +`interface Observer` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/tabstray/src/main/java/mozilla/components/concept/tabstray/TabsTray.kt#L18) + +Interface to be implemented by classes that want to observe a tabs tray. + +### Functions + +| Name | Summary | +|---|---| +| [onTabClosed](on-tab-closed.md) | `abstract fun onTabClosed(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
A tab has been closed. | +| [onTabSelected](on-tab-selected.md) | `abstract fun onTabSelected(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
A new tab has been selected. | + +### Inheritors + +| Name | Summary | +|---|---| +| [TabsTrayInteractor](../../../mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/index.md) | `class TabsTrayInteractor : `[`Observer`](./index.md)
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/mozilla.components.concept.tabstray/-tabs-tray/-observer/on-tab-closed.md b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/-observer/on-tab-closed.md new file mode 100644 index 00000000000..6c3a10ecb79 --- /dev/null +++ b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/-observer/on-tab-closed.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.tabstray](../../index.md) / [TabsTray](../index.md) / [Observer](index.md) / [onTabClosed](./on-tab-closed.md) + +# onTabClosed + +`abstract fun onTabClosed(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/tabstray/src/main/java/mozilla/components/concept/tabstray/TabsTray.kt#L27) + +A tab has been closed. + diff --git a/docs/api/mozilla.components.concept.tabstray/-tabs-tray/-observer/on-tab-selected.md b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/-observer/on-tab-selected.md new file mode 100644 index 00000000000..4da9e1d9e6c --- /dev/null +++ b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/-observer/on-tab-selected.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.tabstray](../../index.md) / [TabsTray](../index.md) / [Observer](index.md) / [onTabSelected](./on-tab-selected.md) + +# onTabSelected + +`abstract fun onTabSelected(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/tabstray/src/main/java/mozilla/components/concept/tabstray/TabsTray.kt#L22) + +A new tab has been selected. + diff --git a/docs/api/mozilla.components.concept.tabstray/-tabs-tray/as-view.md b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/as-view.md new file mode 100644 index 00000000000..ffe4fedb433 --- /dev/null +++ b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/as-view.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.tabstray](../index.md) / [TabsTray](index.md) / [asView](./as-view.md) + +# asView + +`open fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/tabstray/src/main/java/mozilla/components/concept/tabstray/TabsTray.kt#L78) + +Convenience method to cast the implementation of this interface to an Android View object. + diff --git a/docs/api/mozilla.components.concept.tabstray/-tabs-tray/display-sessions.md b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/display-sessions.md new file mode 100644 index 00000000000..50ea6543c09 --- /dev/null +++ b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/display-sessions.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.concept.tabstray](../index.md) / [TabsTray](index.md) / [displaySessions](./display-sessions.md) + +# displaySessions + +`abstract fun displaySessions(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Session`](../../mozilla.components.browser.session/-session/index.md)`>, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/tabstray/src/main/java/mozilla/components/concept/tabstray/TabsTray.kt#L38) + +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/mozilla.components.concept.tabstray/-tabs-tray/index.md b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/index.md new file mode 100644 index 00000000000..c759d4e2e5d --- /dev/null +++ b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/index.md @@ -0,0 +1,44 @@ +[android-components](../../index.md) / [mozilla.components.concept.tabstray](../index.md) / [TabsTray](./index.md) + +# TabsTray + +`interface TabsTray : `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](-observer/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/tabstray/src/main/java/mozilla/components/concept/tabstray/TabsTray.kt#L14) + +Generic interface for components that provide "tabs tray" functionality. + +### Types + +| Name | Summary | +|---|---| +| [Observer](-observer/index.md) | `interface Observer`
Interface to be implemented by classes that want to observe a tabs tray. | + +### Functions + +| Name | Summary | +|---|---| +| [asView](as-view.md) | `open fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html)
Convenience method to cast the implementation of this interface to an Android View object. | +| [displaySessions](display-sessions.md) | `abstract fun displaySessions(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Session`](../../mozilla.components.browser.session/-session/index.md)`>, 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.md) | `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.md) | `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.md) | `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.md) | `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.md) | `abstract fun updateSessions(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Session`](../../mozilla.components.browser.session/-session/index.md)`>, 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. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [notifyObservers](../../mozilla.components.support.base.observer/-observable/notify-observers.md) | `abstract fun notifyObservers(block: `[`T`](../../mozilla.components.support.base.observer/-observable/index.md#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)
Notifies all registered observers about a change. | +| [pauseObserver](../../mozilla.components.support.base.observer/-observable/pause-observer.md) | `abstract fun pauseObserver(observer: `[`T`](../../mozilla.components.support.base.observer/-observable/index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Pauses the provided observer. No notifications will be sent to this observer until [resumeObserver](../../mozilla.components.support.base.observer/-observable/resume-observer.md) is called. | +| [register](../../mozilla.components.support.base.observer/-observable/register.md) | `abstract fun register(observer: `[`T`](../../mozilla.components.support.base.observer/-observable/index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
`abstract fun register(observer: `[`T`](../../mozilla.components.support.base.observer/-observable/index.md#T)`, owner: LifecycleOwner, autoPause: `[`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)
`abstract fun register(observer: `[`T`](../../mozilla.components.support.base.observer/-observable/index.md#T)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Registers an observer to get notified about changes. | +| [resumeObserver](../../mozilla.components.support.base.observer/-observable/resume-observer.md) | `abstract fun resumeObserver(observer: `[`T`](../../mozilla.components.support.base.observer/-observable/index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Resumes the provided observer. Notifications sent since it was last paused (see [pauseObserver](../../mozilla.components.support.base.observer/-observable/pause-observer.md)]) are lost and will not be re-delivered. | +| [unregister](../../mozilla.components.support.base.observer/-observable/unregister.md) | `abstract fun unregister(observer: `[`T`](../../mozilla.components.support.base.observer/-observable/index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Unregisters an observer. | +| [unregisterObservers](../../mozilla.components.support.base.observer/-observable/unregister-observers.md) | `abstract fun unregisterObservers(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Unregisters all observers. | +| [wrapConsumers](../../mozilla.components.support.base.observer/-observable/wrap-consumers.md) | `abstract fun wrapConsumers(block: `[`T`](../../mozilla.components.support.base.observer/-observable/index.md#T)`.(`[`R`](../../mozilla.components.support.base.observer/-observable/wrap-consumers.md#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`](../../mozilla.components.support.base.observer/-observable/wrap-consumers.md#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 + +| Name | Summary | +|---|---| +| [BrowserTabsTray](../../mozilla.components.browser.tabstray/-browser-tabs-tray/index.md) | `class BrowserTabsTray : RecyclerView, `[`TabsTray`](./index.md)
A customizable tabs tray for browsers. | +| [TabsAdapter](../../mozilla.components.browser.tabstray/-tabs-adapter/index.md) | `class TabsAdapter : Adapter<`[`TabViewHolder`](../../mozilla.components.browser.tabstray/-tab-view-holder/index.md)`>, `[`TabsTray`](./index.md)`, `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](-observer/index.md)`>`
RecyclerView adapter implementation to display a list/grid of tabs. | diff --git a/docs/api/mozilla.components.concept.tabstray/-tabs-tray/on-session-moved.md b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/on-session-moved.md new file mode 100644 index 00000000000..9f0f586746f --- /dev/null +++ b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/on-session-moved.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.tabstray](../index.md) / [TabsTray](index.md) / [onSessionMoved](./on-session-moved.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/tabstray/src/main/java/mozilla/components/concept/tabstray/TabsTray.kt#L67) + +Called after updateSessions() when a session changes it position. + diff --git a/docs/api/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-changed.md b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-changed.md new file mode 100644 index 00000000000..cbe715e5b04 --- /dev/null +++ b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-changed.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.concept.tabstray](../index.md) / [TabsTray](index.md) / [onSessionsChanged](./on-sessions-changed.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/tabstray/src/main/java/mozilla/components/concept/tabstray/TabsTray.kt#L73) + +Called after updateSessions() when count number of sessions are updated at the +given position. + diff --git a/docs/api/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-inserted.md b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-inserted.md new file mode 100644 index 00000000000..4492191aad8 --- /dev/null +++ b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-inserted.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.concept.tabstray](../index.md) / [TabsTray](index.md) / [onSessionsInserted](./on-sessions-inserted.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/tabstray/src/main/java/mozilla/components/concept/tabstray/TabsTray.kt#L56) + +Called after updateSessions() when count number of sessions are inserted at the +given position. + diff --git a/docs/api/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-removed.md b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-removed.md new file mode 100644 index 00000000000..137dbadadf7 --- /dev/null +++ b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/on-sessions-removed.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.concept.tabstray](../index.md) / [TabsTray](index.md) / [onSessionsRemoved](./on-sessions-removed.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/tabstray/src/main/java/mozilla/components/concept/tabstray/TabsTray.kt#L62) + +Called after updateSessions() when count number of sessions are removed from +the given position. + diff --git a/docs/api/mozilla.components.concept.tabstray/-tabs-tray/update-sessions.md b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/update-sessions.md new file mode 100644 index 00000000000..ad96c834198 --- /dev/null +++ b/docs/api/mozilla.components.concept.tabstray/-tabs-tray/update-sessions.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.concept.tabstray](../index.md) / [TabsTray](index.md) / [updateSessions](./update-sessions.md) + +# updateSessions + +`abstract fun updateSessions(sessions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Session`](../../mozilla.components.browser.session/-session/index.md)`>, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/tabstray/src/main/java/mozilla/components/concept/tabstray/TabsTray.kt#L50) + +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/mozilla.components.concept.tabstray/index.md b/docs/api/mozilla.components.concept.tabstray/index.md new file mode 100644 index 00000000000..a7ffdaba18a --- /dev/null +++ b/docs/api/mozilla.components.concept.tabstray/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.concept.tabstray](./index.md) + +## Package mozilla.components.concept.tabstray + +### Types + +| Name | Summary | +|---|---| +| [TabsTray](-tabs-tray/index.md) | `interface TabsTray : `[`Observable`](../mozilla.components.support.base.observer/-observable/index.md)`<`[`Observer`](-tabs-tray/-observer/index.md)`>`
Generic interface for components that provide "tabs tray" functionality. | diff --git a/docs/api/mozilla.components.concept.toolbar/-autocomplete-delegate/apply-autocomplete-result.md b/docs/api/mozilla.components.concept.toolbar/-autocomplete-delegate/apply-autocomplete-result.md new file mode 100644 index 00000000000..c705f233042 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-autocomplete-delegate/apply-autocomplete-result.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [AutocompleteDelegate](index.md) / [applyAutocompleteResult](./apply-autocomplete-result.md) + +# applyAutocompleteResult + +`abstract fun applyAutocompleteResult(result: `[`AutocompleteResult`](../-autocomplete-result/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/AutocompleteDelegate.kt#L15) + +### Parameters + +`result` - Apply result of autocompletion. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.toolbar/-autocomplete-delegate/index.md b/docs/api/mozilla.components.concept.toolbar/-autocomplete-delegate/index.md new file mode 100644 index 00000000000..dc83e44229c --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-autocomplete-delegate/index.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [AutocompleteDelegate](./index.md) + +# AutocompleteDelegate + +`interface AutocompleteDelegate` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/AutocompleteDelegate.kt#L11) + +Describes an object to which a [AutocompleteResult](../-autocomplete-result/index.md) may be applied. +Usually, this will delegate to a specific text view. + +### Functions + +| Name | Summary | +|---|---| +| [applyAutocompleteResult](apply-autocomplete-result.md) | `abstract fun applyAutocompleteResult(result: `[`AutocompleteResult`](../-autocomplete-result/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [noAutocompleteResult](no-autocomplete-result.md) | `abstract fun noAutocompleteResult(input: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Autocompletion was invoked and no match was returned. | + +### Inheritors + +| Name | Summary | +|---|---| +| [AsyncAutocompleteDelegate](../../mozilla.components.browser.toolbar/-async-autocomplete-delegate/index.md) | `class AsyncAutocompleteDelegate : `[`AutocompleteDelegate`](./index.md)`, CoroutineScope`
An autocomplete delegate which is aware of its parent scope (to check for cancellations). Responsible for processing autocompletion results and discarding stale results when [urlView](#) moved on. | diff --git a/docs/api/mozilla.components.concept.toolbar/-autocomplete-delegate/no-autocomplete-result.md b/docs/api/mozilla.components.concept.toolbar/-autocomplete-delegate/no-autocomplete-result.md new file mode 100644 index 00000000000..c02511cd767 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-autocomplete-delegate/no-autocomplete-result.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [AutocompleteDelegate](index.md) / [noAutocompleteResult](./no-autocomplete-result.md) + +# noAutocompleteResult + +`abstract fun noAutocompleteResult(input: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/AutocompleteDelegate.kt#L20) + +Autocompletion was invoked and no match was returned. + diff --git a/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/-init-.md b/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/-init-.md new file mode 100644 index 00000000000..bf1f066f309 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [AutocompleteResult](index.md) / [<init>](./-init-.md) + +# <init> + +`AutocompleteResult(input: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, 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)`, totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` + +Describes an autocompletion result. + diff --git a/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/index.md b/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/index.md new file mode 100644 index 00000000000..1661d819f5d --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [AutocompleteResult](./index.md) + +# AutocompleteResult + +`data class AutocompleteResult` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/AutocompleteDelegate.kt#L31) + +Describes an autocompletion result. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AutocompleteResult(input: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, 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)`, totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)`
Describes an autocompletion result. | + +### Properties + +| Name | Summary | +|---|---| +| [input](input.md) | `val input: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Input for which this AutocompleteResult is being provided. | +| [source](source.md) | `val source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Name of the autocompletion source. | +| [text](text.md) | `val text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
AutocompleteResult of autocompletion, text to be displayed. | +| [totalItems](total-items.md) | `val totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
A total number of results also available. | +| [url](url.md) | `val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
AutocompleteResult of autocompletion, full matching url. | diff --git a/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/input.md b/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/input.md new file mode 100644 index 00000000000..ce6e04fea0f --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/input.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [AutocompleteResult](index.md) / [input](./input.md) + +# input + +`val input: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/AutocompleteDelegate.kt#L32) + +Input for which this AutocompleteResult is being provided. + +### Property + +`input` - Input for which this AutocompleteResult is being provided. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/source.md b/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/source.md new file mode 100644 index 00000000000..a9a6c82c7fc --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/source.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [AutocompleteResult](index.md) / [source](./source.md) + +# source + +`val source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/AutocompleteDelegate.kt#L35) + +Name of the autocompletion source. + +### Property + +`source` - Name of the autocompletion source. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/text.md b/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/text.md new file mode 100644 index 00000000000..3d59a97ffba --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/text.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [AutocompleteResult](index.md) / [text](./text.md) + +# text + +`val text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/AutocompleteDelegate.kt#L33) + +AutocompleteResult of autocompletion, text to be displayed. + +### Property + +`text` - AutocompleteResult of autocompletion, text to be displayed. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/total-items.md b/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/total-items.md new file mode 100644 index 00000000000..3f439e98144 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/total-items.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [AutocompleteResult](index.md) / [totalItems](./total-items.md) + +# totalItems + +`val totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/AutocompleteDelegate.kt#L36) + +A total number of results also available. + +### Property + +`totalItems` - A total number of results also available. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/url.md b/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/url.md new file mode 100644 index 00000000000..f48781b5dd8 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-autocomplete-result/url.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [AutocompleteResult](index.md) / [url](./url.md) + +# url + +`val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/AutocompleteDelegate.kt#L34) + +AutocompleteResult of autocompletion, full matching url. + +### Property + +`url` - AutocompleteResult of autocompletion, full matching url. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/-init-.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/-init-.md new file mode 100644 index 00000000000..d9dfb01293e --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/-init-.md @@ -0,0 +1,19 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionButton](index.md) / [<init>](./-init-.md) + +# <init> + +`ActionButton(imageDrawable: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`? = null, 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)` = 0, padding: `[`Padding`](../../../mozilla.components.support.base.android/-padding/index.md)`? = null, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +An action button to be added to the toolbar. + +### Parameters + +`imageDrawable` - 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. + +`padding` - A optional custom padding. + +`listener` - Callback that will be invoked whenever the button is pressed \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/bind.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/bind.md new file mode 100644 index 00000000000..d9401d7ead0 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/bind.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionButton](index.md) / [bind](./bind.md) + +# bind + +`open fun bind(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L178) + +Overrides [Action.bind](../-action/bind.md) + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/content-description.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/content-description.md new file mode 100644 index 00000000000..434ecf4c38d --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/content-description.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionButton](index.md) / [contentDescription](./content-description.md) + +# contentDescription + +`val contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L152) + +The content description to use. + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/create-view.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/create-view.md new file mode 100644 index 00000000000..00af3811f25 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/create-view.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionButton](index.md) / [createView](./create-view.md) + +# createView + +`open fun createView(parent: `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`): `[`View`](https://developer.android.com/reference/android/view/View.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L159) + +Overrides [Action.createView](../-action/create-view.md) + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/image-drawable.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/image-drawable.md new file mode 100644 index 00000000000..98d35f9066e --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/image-drawable.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionButton](index.md) / [imageDrawable](./image-drawable.md) + +# imageDrawable + +`val imageDrawable: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L151) + +The drawable to be shown. + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/index.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/index.md new file mode 100644 index 00000000000..b0eecce1a87 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/index.md @@ -0,0 +1,46 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionButton](./index.md) + +# ActionButton + +`open class ActionButton : `[`Action`](../-action/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L150) + +An action button to be added to the toolbar. + +### Parameters + +`imageDrawable` - 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. + +`padding` - A optional custom padding. + +`listener` - Callback that will be invoked whenever the button is pressed + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ActionButton(imageDrawable: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`? = null, 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)` = 0, padding: `[`Padding`](../../../mozilla.components.support.base.android/-padding/index.md)`? = null, listener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
An action button to be added to the toolbar. | + +### Properties + +| Name | Summary | +|---|---| +| [contentDescription](content-description.md) | `val contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The content description to use. | +| [imageDrawable](image-drawable.md) | `val imageDrawable: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`?`
The drawable to be shown. | +| [visible](visible.md) | `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 + +| Name | Summary | +|---|---| +| [bind](bind.md) | `open fun bind(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [createView](create-view.md) | `open fun createView(parent: `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`): `[`View`](https://developer.android.com/reference/android/view/View.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [Button](../../../mozilla.components.browser.toolbar/-browser-toolbar/-button/index.md) | `class Button : `[`ActionButton`](./index.md)
An action button to be added to the toolbar. | diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/visible.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/visible.md new file mode 100644 index 00000000000..7a6918b2c34 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-button/visible.md @@ -0,0 +1,10 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionButton](index.md) / [visible](./visible.md) + +# visible + +`open val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L153) + +Overrides [Action.visible](../-action/visible.md) + +Lambda that returns true or false to indicate whether this button should be shown. + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-image/-init-.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-image/-init-.md new file mode 100644 index 00000000000..e9e1681290f --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-image/-init-.md @@ -0,0 +1,17 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionImage](index.md) / [<init>](./-init-.md) + +# <init> + +`ActionImage(imageDrawable: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`, contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, padding: `[`Padding`](../../../mozilla.components.support.base.android/-padding/index.md)`? = null)` + +An action that just shows a static, non-clickable image. + +### Parameters + +`imageDrawable` - 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. + +`padding` - A optional custom padding. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-image/bind.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-image/bind.md new file mode 100644 index 00000000000..77b9bf98a06 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-image/bind.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionImage](index.md) / [bind](./bind.md) + +# bind + +`open fun bind(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L326) + +Overrides [Action.bind](../-action/bind.md) + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-image/create-view.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-image/create-view.md new file mode 100644 index 00000000000..6630d14d32f --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-image/create-view.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionImage](index.md) / [createView](./create-view.md) + +# createView + +`open fun createView(parent: `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`): `[`View`](https://developer.android.com/reference/android/view/View.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L313) + +Overrides [Action.createView](../-action/create-view.md) + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-image/index.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-image/index.md new file mode 100644 index 00000000000..78790d922c1 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-image/index.md @@ -0,0 +1,36 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionImage](./index.md) + +# ActionImage + +`open class ActionImage : `[`Action`](../-action/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L307) + +An action that just shows a static, non-clickable image. + +### Parameters + +`imageDrawable` - 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. + +`padding` - A optional custom padding. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ActionImage(imageDrawable: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`, contentDescription: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, padding: `[`Padding`](../../../mozilla.components.support.base.android/-padding/index.md)`? = null)`
An action that just shows a static, non-clickable image. | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [visible](../-action/visible.md) | `open val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [bind](bind.md) | `open fun bind(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [createView](create-view.md) | `open fun createView(parent: `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`): `[`View`](https://developer.android.com/reference/android/view/View.html) | diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-space/-init-.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-space/-init-.md new file mode 100644 index 00000000000..36887b6e1ed --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-space/-init-.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionSpace](index.md) / [<init>](./-init-.md) + +# <init> + +`ActionSpace(desiredWidth: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, padding: `[`Padding`](../../../mozilla.components.support.base.android/-padding/index.md)`? = null)` + +An "empty" action with a desired width to be used as "placeholder". + +### Parameters + +`desiredWidth` - The desired width in density independent pixels for this action. + +`padding` - A optional custom padding. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-space/bind.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-space/bind.md new file mode 100644 index 00000000000..ae4f1897e7e --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-space/bind.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionSpace](index.md) / [bind](./bind.md) + +# bind + +`open fun bind(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L295) + +Overrides [Action.bind](../-action/bind.md) + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-space/create-view.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-space/create-view.md new file mode 100644 index 00000000000..e571a659c0e --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-space/create-view.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionSpace](index.md) / [createView](./create-view.md) + +# createView + +`open fun createView(parent: `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`): `[`View`](https://developer.android.com/reference/android/view/View.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L290) + +Overrides [Action.createView](../-action/create-view.md) + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-space/index.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-space/index.md new file mode 100644 index 00000000000..af024e2186c --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-space/index.md @@ -0,0 +1,32 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionSpace](./index.md) + +# ActionSpace + +`open class ActionSpace : `[`Action`](../-action/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L286) + +An "empty" action with a desired width to be used as "placeholder". + +### Parameters + +`desiredWidth` - The desired width in density independent pixels for this action. + +`padding` - A optional custom padding. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ActionSpace(desiredWidth: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, padding: `[`Padding`](../../../mozilla.components.support.base.android/-padding/index.md)`? = null)`
An "empty" action with a desired width to be used as "placeholder". | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [visible](../-action/visible.md) | `open val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [bind](bind.md) | `open fun bind(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [createView](create-view.md) | `open fun createView(parent: `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`): `[`View`](https://developer.android.com/reference/android/view/View.html) | diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/-init-.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/-init-.md new file mode 100644 index 00000000000..0beddca6554 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/-init-.md @@ -0,0 +1,26 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionToggleButton](index.md) / [<init>](./-init-.md) + +# <init> + +`ActionToggleButton(imageDrawable: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`, imageSelectedDrawable: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.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)` = 0, padding: `[`Padding`](../../../mozilla.components.support.base.android/-padding/index.md)`? = 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 + +`imageDrawable` - The drawable to be shown if the button is in unselected state. + +`imageSelectedDrawable` - 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. + +`padding` - A optional custom padding. + +`listener` - Callback that will be invoked whenever the checked state changes. \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/bind.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/bind.md new file mode 100644 index 00000000000..48f37d381f1 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/bind.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionToggleButton](index.md) / [bind](./bind.md) + +# bind + +`open fun bind(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L277) + +Overrides [Action.bind](../-action/bind.md) + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/create-view.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/create-view.md new file mode 100644 index 00000000000..41b1639aa54 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/create-view.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionToggleButton](index.md) / [createView](./create-view.md) + +# createView + +`open fun createView(parent: `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`): `[`View`](https://developer.android.com/reference/android/view/View.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L207) + +Overrides [Action.createView](../-action/create-view.md) + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/index.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/index.md new file mode 100644 index 00000000000..89c0c228589 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/index.md @@ -0,0 +1,54 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionToggleButton](./index.md) + +# ActionToggleButton + +`open class ActionToggleButton : `[`Action`](../-action/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L194) + +An action button with two states, selected and unselected. When the button is pressed, the +state changes automatically. + +### Parameters + +`imageDrawable` - The drawable to be shown if the button is in unselected state. + +`imageSelectedDrawable` - 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. + +`padding` - A optional custom padding. + +`listener` - Callback that will be invoked whenever the checked state changes. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ActionToggleButton(imageDrawable: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`, imageSelectedDrawable: `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.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)` = 0, padding: `[`Padding`](../../../mozilla.components.support.base.android/-padding/index.md)`? = 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 + +| Name | Summary | +|---|---| +| [visible](visible.md) | `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 + +| Name | Summary | +|---|---| +| [bind](bind.md) | `open fun bind(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [createView](create-view.md) | `open fun createView(parent: `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`): `[`View`](https://developer.android.com/reference/android/view/View.html) | +| [isSelected](is-selected.md) | `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.md) | `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.md) | `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. | + +### Inheritors + +| Name | Summary | +|---|---| +| [ToggleButton](../../../mozilla.components.browser.toolbar/-browser-toolbar/-toggle-button/index.md) | `class ToggleButton : `[`ActionToggleButton`](./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/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/is-selected.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/is-selected.md new file mode 100644 index 00000000000..686e43600ff --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/is-selected.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionToggleButton](index.md) / [isSelected](./is-selected.md) + +# isSelected + +`fun isSelected(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L261) + +Returns the current selected state of the action. + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/set-selected.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/set-selected.md new file mode 100644 index 00000000000..3ab9b8e25e5 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/set-selected.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionToggleButton](index.md) / [setSelected](./set-selected.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L244) + +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/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/toggle.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/toggle.md new file mode 100644 index 00000000000..16761cb8bb6 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/toggle.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionToggleButton](index.md) / [toggle](./toggle.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L234) + +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/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/visible.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/visible.md new file mode 100644 index 00000000000..cc0cc4efcd7 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action-toggle-button/visible.md @@ -0,0 +1,10 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [ActionToggleButton](index.md) / [visible](./visible.md) + +# visible + +`open val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L199) + +Overrides [Action.visible](../-action/visible.md) + +Lambda that returns true or false to indicate whether this button should be shown. + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action/bind.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action/bind.md new file mode 100644 index 00000000000..ee8edbe32b9 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action/bind.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [Action](index.md) / [bind](./bind.md) + +# bind + +`abstract fun bind(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L138) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action/create-view.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action/create-view.md new file mode 100644 index 00000000000..be559d4f8c7 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action/create-view.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [Action](index.md) / [createView](./create-view.md) + +# createView + +`abstract fun createView(parent: `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`): `[`View`](https://developer.android.com/reference/android/view/View.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L136) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action/index.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action/index.md new file mode 100644 index 00000000000..9fdd6fdaa4b --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action/index.md @@ -0,0 +1,30 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [Action](./index.md) + +# Action + +`interface Action` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L132) + +Generic interface for actions to be added to the toolbar. + +### Properties + +| Name | Summary | +|---|---| +| [visible](visible.md) | `open val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [bind](bind.md) | `abstract fun bind(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [createView](create-view.md) | `abstract fun createView(parent: `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`): `[`View`](https://developer.android.com/reference/android/view/View.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [ActionButton](../-action-button/index.md) | `open class ActionButton : `[`Action`](./index.md)
An action button to be added to the toolbar. | +| [ActionImage](../-action-image/index.md) | `open class ActionImage : `[`Action`](./index.md)
An action that just shows a static, non-clickable image. | +| [ActionSpace](../-action-space/index.md) | `open class ActionSpace : `[`Action`](./index.md)
An "empty" action with a desired width to be used as "placeholder". | +| [ActionToggleButton](../-action-toggle-button/index.md) | `open class ActionToggleButton : `[`Action`](./index.md)
An action button with two states, selected and unselected. When the button is pressed, the state changes automatically. | +| [TabCounterToolbarButton](../../../mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/index.md) | `class TabCounterToolbarButton : `[`Action`](./index.md)
A [Toolbar.Action](./index.md) implementation that shows a [TabCounter](../../../mozilla.components.ui.tabcounter/-tab-counter/index.md). | diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-action/visible.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action/visible.md new file mode 100644 index 00000000000..f193fdbd628 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-action/visible.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [Action](index.md) / [visible](./visible.md) + +# visible + +`open val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L133) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/index.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/index.md new file mode 100644 index 00000000000..675fd9ac10b --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/index.md @@ -0,0 +1,15 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [OnEditListener](./index.md) + +# OnEditListener + +`interface OnEditListener` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L112) + +Listener to be invoked when the user edits the URL. + +### Functions + +| Name | Summary | +|---|---| +| [onStartEditing](on-start-editing.md) | `open fun onStartEditing(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Fired when the toolbar switches to edit mode. | +| [onStopEditing](on-stop-editing.md) | `open fun onStopEditing(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Fired when the toolbar switches back to display mode. | +| [onTextChanged](on-text-changed.md) | `open fun onTextChanged(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)
Fired whenever the user changes the text in the address bar. | diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/on-start-editing.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/on-start-editing.md new file mode 100644 index 00000000000..62e760b8f43 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/on-start-editing.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [OnEditListener](index.md) / [onStartEditing](./on-start-editing.md) + +# onStartEditing + +`open fun onStartEditing(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L116) + +Fired when the toolbar switches to edit mode. + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/on-stop-editing.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/on-stop-editing.md new file mode 100644 index 00000000000..e085d88649e --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/on-stop-editing.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [OnEditListener](index.md) / [onStopEditing](./on-stop-editing.md) + +# onStopEditing + +`open fun onStopEditing(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L121) + +Fired when the toolbar switches back to display mode. + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/on-text-changed.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/on-text-changed.md new file mode 100644 index 00000000000..248e8ce91eb --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-on-edit-listener/on-text-changed.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [OnEditListener](index.md) / [onTextChanged](./on-text-changed.md) + +# onTextChanged + +`open fun onTextChanged(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L126) + +Fired whenever the user changes the text in the address bar. + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-site-security/-i-n-s-e-c-u-r-e.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-site-security/-i-n-s-e-c-u-r-e.md new file mode 100644 index 00000000000..8f6d7b1e33e --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-site-security/-i-n-s-e-c-u-r-e.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [SiteSecurity](index.md) / [INSECURE](./-i-n-s-e-c-u-r-e.md) + +# INSECURE + +`INSECURE` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L330) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-site-security/-s-e-c-u-r-e.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-site-security/-s-e-c-u-r-e.md new file mode 100644 index 00000000000..f01b0677794 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-site-security/-s-e-c-u-r-e.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [SiteSecurity](index.md) / [SECURE](./-s-e-c-u-r-e.md) + +# SECURE + +`SECURE` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L331) \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/-site-security/index.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/-site-security/index.md new file mode 100644 index 00000000000..5a7c4cbddb0 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/-site-security/index.md @@ -0,0 +1,12 @@ +[android-components](../../../index.md) / [mozilla.components.concept.toolbar](../../index.md) / [Toolbar](../index.md) / [SiteSecurity](./index.md) + +# SiteSecurity + +`enum class SiteSecurity` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L329) + +### Enum Values + +| Name | Summary | +|---|---| +| [INSECURE](-i-n-s-e-c-u-r-e.md) | | +| [SECURE](-s-e-c-u-r-e.md) | | diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/add-browser-action.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/add-browser-action.md new file mode 100644 index 00000000000..4875a6542b3 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/add-browser-action.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [Toolbar](index.md) / [addBrowserAction](./add-browser-action.md) + +# addBrowserAction + +`abstract fun addBrowserAction(action: `[`Action`](-action/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L74) + +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/mozilla.components.concept.toolbar/-toolbar/add-navigation-action.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/add-navigation-action.md new file mode 100644 index 00000000000..5d3c395ea7e --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/add-navigation-action.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [Toolbar](index.md) / [addNavigationAction](./add-navigation-action.md) + +# addNavigationAction + +`abstract fun addNavigationAction(action: `[`Action`](-action/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L87) + +Adds an action to be displayed on the far left side of the URL in display mode. + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/add-page-action.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/add-page-action.md new file mode 100644 index 00000000000..81f0f059b52 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/add-page-action.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [Toolbar](index.md) / [addPageAction](./add-page-action.md) + +# addPageAction + +`abstract fun addPageAction(action: `[`Action`](-action/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L82) + +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/mozilla.components.concept.toolbar/-toolbar/as-view.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/as-view.md new file mode 100644 index 00000000000..a051d928f16 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/as-view.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [Toolbar](index.md) / [asView](./as-view.md) + +# asView + +`open fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L92) + +Casts this toolbar to an Android View object. + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/display-mode.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/display-mode.md new file mode 100644 index 00000000000..2c473753843 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/display-mode.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [Toolbar](index.md) / [displayMode](./display-mode.md) + +# displayMode + +`abstract fun displayMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L102) + +Switches to URL displaying mode (from editing mode) if supported by the toolbar implementation. + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/display-progress.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/display-progress.md new file mode 100644 index 00000000000..1330a2bd5a6 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/display-progress.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [Toolbar](index.md) / [displayProgress](./display-progress.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L44) + +Displays the given loading progress. Expects values in the range [0,100](#). + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/edit-mode.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/edit-mode.md new file mode 100644 index 00000000000..08406a203c7 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/edit-mode.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [Toolbar](index.md) / [editMode](./edit-mode.md) + +# editMode + +`abstract fun editMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L107) + +Switches to URL editing mode (from displaying mode) if supported by the toolbar implementation. + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/index.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/index.md new file mode 100644 index 00000000000..ae78f33da62 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/index.md @@ -0,0 +1,49 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [Toolbar](./index.md) + +# Toolbar + +`interface Toolbar` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L23) + +Interface to be implemented by components that provide browser toolbar functionality. + +### Types + +| Name | Summary | +|---|---| +| [Action](-action/index.md) | `interface Action`
Generic interface for actions to be added to the toolbar. | +| [ActionButton](-action-button/index.md) | `open class ActionButton : `[`Action`](-action/index.md)
An action button to be added to the toolbar. | +| [ActionImage](-action-image/index.md) | `open class ActionImage : `[`Action`](-action/index.md)
An action that just shows a static, non-clickable image. | +| [ActionSpace](-action-space/index.md) | `open class ActionSpace : `[`Action`](-action/index.md)
An "empty" action with a desired width to be used as "placeholder". | +| [ActionToggleButton](-action-toggle-button/index.md) | `open class ActionToggleButton : `[`Action`](-action/index.md)
An action button with two states, selected and unselected. When the button is pressed, the state changes automatically. | +| [OnEditListener](-on-edit-listener/index.md) | `interface OnEditListener`
Listener to be invoked when the user edits the URL. | +| [SiteSecurity](-site-security/index.md) | `enum class SiteSecurity` | + +### Properties + +| Name | Summary | +|---|---| +| [siteSecure](site-secure.md) | `abstract var siteSecure: `[`SiteSecurity`](-site-security/index.md)
Sets/Gets the site security to be displayed on the toolbar. | +| [url](url.md) | `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 + +| Name | Summary | +|---|---| +| [addBrowserAction](add-browser-action.md) | `abstract fun addBrowserAction(action: `[`Action`](-action/index.md)`): `[`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.md) | `abstract fun addNavigationAction(action: `[`Action`](-action/index.md)`): `[`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.md) | `abstract fun addPageAction(action: `[`Action`](-action/index.md)`): `[`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.md) | `open fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html)
Casts this toolbar to an Android View object. | +| [displayMode](display-mode.md) | `abstract fun displayMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Switches to URL displaying mode (from editing mode) if supported by the toolbar implementation. | +| [displayProgress](display-progress.md) | `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](#). | +| [editMode](edit-mode.md) | `abstract fun editMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Switches to URL editing mode (from displaying mode) if supported by the toolbar implementation. | +| [onBackPressed](on-back-pressed.md) | `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. | +| [setAutocompleteListener](set-autocomplete-listener.md) | `abstract fun setAutocompleteListener(filter: suspend (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`AutocompleteDelegate`](../-autocomplete-delegate/index.md)`) -> `[`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 users changes text in the toolbar. | +| [setOnEditListener](set-on-edit-listener.md) | `abstract fun setOnEditListener(listener: `[`OnEditListener`](-on-edit-listener/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Registers the given listener to be invoked when the user edits the URL. | +| [setOnUrlCommitListener](set-on-url-commit-listener.md) | `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.md) | `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. | + +### Inheritors + +| Name | Summary | +|---|---| +| [BrowserToolbar](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md) | `class BrowserToolbar : `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`, `[`Toolbar`](./index.md)
A customizable toolbar for browsers. | diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/on-back-pressed.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/on-back-pressed.md new file mode 100644 index 00000000000..34c9fee6bc2 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/on-back-pressed.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [Toolbar](index.md) / [onBackPressed](./on-back-pressed.md) + +# onBackPressed + +`abstract fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L51) + +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/mozilla.components.concept.toolbar/-toolbar/set-autocomplete-listener.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/set-autocomplete-listener.md new file mode 100644 index 00000000000..817b92fe4ef --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/set-autocomplete-listener.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [Toolbar](index.md) / [setAutocompleteListener](./set-autocomplete-listener.md) + +# setAutocompleteListener + +`abstract fun setAutocompleteListener(filter: suspend (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`AutocompleteDelegate`](../-autocomplete-delegate/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L66) + +Registers the given function to be invoked when users changes text in the toolbar. + +### Parameters + +`filter` - A function which will perform autocompletion and send results to [AutocompleteDelegate](../-autocomplete-delegate/index.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/set-on-edit-listener.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/set-on-edit-listener.md new file mode 100644 index 00000000000..a866143bb0b --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/set-on-edit-listener.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [Toolbar](index.md) / [setOnEditListener](./set-on-edit-listener.md) + +# setOnEditListener + +`abstract fun setOnEditListener(listener: `[`OnEditListener`](-on-edit-listener/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L97) + +Registers the given listener to be invoked when the user edits the URL. + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/set-on-url-commit-listener.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/set-on-url-commit-listener.md new file mode 100644 index 00000000000..a1d075b4b16 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/set-on-url-commit-listener.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [Toolbar](index.md) / [setOnUrlCommitListener](./set-on-url-commit-listener.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L59) + +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/mozilla.components.concept.toolbar/-toolbar/set-search-terms.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/set-search-terms.md new file mode 100644 index 00000000000..497951dc7fd --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/set-search-terms.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [Toolbar](index.md) / [setSearchTerms](./set-search-terms.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L39) + +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/mozilla.components.concept.toolbar/-toolbar/site-secure.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/site-secure.md new file mode 100644 index 00000000000..5ef87504022 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/site-secure.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [Toolbar](index.md) / [siteSecure](./site-secure.md) + +# siteSecure + +`abstract var siteSecure: `[`SiteSecurity`](-site-security/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L32) + +Sets/Gets the site security to be displayed on the toolbar. + diff --git a/docs/api/mozilla.components.concept.toolbar/-toolbar/url.md b/docs/api/mozilla.components.concept.toolbar/-toolbar/url.md new file mode 100644 index 00000000000..11d0b3cd756 --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/-toolbar/url.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.concept.toolbar](../index.md) / [Toolbar](index.md) / [url](./url.md) + +# url + +`abstract var url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt#L27) + +Sets/Gets the URL to be displayed on the toolbar. + diff --git a/docs/api/mozilla.components.concept.toolbar/index.md b/docs/api/mozilla.components.concept.toolbar/index.md new file mode 100644 index 00000000000..6eb13ce260b --- /dev/null +++ b/docs/api/mozilla.components.concept.toolbar/index.md @@ -0,0 +1,11 @@ +[android-components](../index.md) / [mozilla.components.concept.toolbar](./index.md) + +## Package mozilla.components.concept.toolbar + +### Types + +| Name | Summary | +|---|---| +| [AutocompleteDelegate](-autocomplete-delegate/index.md) | `interface AutocompleteDelegate`
Describes an object to which a [AutocompleteResult](-autocomplete-result/index.md) may be applied. Usually, this will delegate to a specific text view. | +| [AutocompleteResult](-autocomplete-result/index.md) | `data class AutocompleteResult`
Describes an autocompletion result. | +| [Toolbar](-toolbar/index.md) | `interface Toolbar`
Interface to be implemented by components that provide browser toolbar functionality. | diff --git a/docs/api/mozilla.components.feature.accounts/-firefox-accounts-auth-feature/-init-.md b/docs/api/mozilla.components.feature.accounts/-firefox-accounts-auth-feature/-init-.md new file mode 100644 index 00000000000..ca064144666 --- /dev/null +++ b/docs/api/mozilla.components.feature.accounts/-firefox-accounts-auth-feature/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.feature.accounts](../index.md) / [FirefoxAccountsAuthFeature](index.md) / [<init>](./-init-.md) + +# <init> + +`FirefoxAccountsAuthFeature(accountManager: `[`FxaAccountManager`](../../mozilla.components.service.fxa/-fxa-account-manager/index.md)`, tabsUseCases: `[`TabsUseCases`](../../mozilla.components.feature.tabs/-tabs-use-cases/index.md)`, redirectUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, successPath: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, coroutineContext: `[`CoroutineContext`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html)` = Dispatchers.Main)` + +Ties together an account manager with a session manager/tabs implementation, facilitating an +authentication flow. + diff --git a/docs/api/mozilla.components.feature.accounts/-firefox-accounts-auth-feature/begin-authentication.md b/docs/api/mozilla.components.feature.accounts/-firefox-accounts-auth-feature/begin-authentication.md new file mode 100644 index 00000000000..56c28202ec3 --- /dev/null +++ b/docs/api/mozilla.components.feature.accounts/-firefox-accounts-auth-feature/begin-authentication.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.accounts](../index.md) / [FirefoxAccountsAuthFeature](index.md) / [beginAuthentication](./begin-authentication.md) + +# beginAuthentication + +`fun beginAuthentication(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/accounts/src/main/java/mozilla/components/feature/accounts/FirefoxAccountsAuthFeature.kt#L29) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.accounts/-firefox-accounts-auth-feature/index.md b/docs/api/mozilla.components.feature.accounts/-firefox-accounts-auth-feature/index.md new file mode 100644 index 00000000000..10744b3641b --- /dev/null +++ b/docs/api/mozilla.components.feature.accounts/-firefox-accounts-auth-feature/index.md @@ -0,0 +1,26 @@ +[android-components](../../index.md) / [mozilla.components.feature.accounts](../index.md) / [FirefoxAccountsAuthFeature](./index.md) + +# FirefoxAccountsAuthFeature + +`class FirefoxAccountsAuthFeature` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/accounts/src/main/java/mozilla/components/feature/accounts/FirefoxAccountsAuthFeature.kt#L22) + +Ties together an account manager with a session manager/tabs implementation, facilitating an +authentication flow. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FirefoxAccountsAuthFeature(accountManager: `[`FxaAccountManager`](../../mozilla.components.service.fxa/-fxa-account-manager/index.md)`, tabsUseCases: `[`TabsUseCases`](../../mozilla.components.feature.tabs/-tabs-use-cases/index.md)`, redirectUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, successPath: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, coroutineContext: `[`CoroutineContext`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html)` = Dispatchers.Main)`
Ties together an account manager with a session manager/tabs implementation, facilitating an authentication flow. | + +### Properties + +| Name | Summary | +|---|---| +| [interceptor](interceptor.md) | `val interceptor: `[`RequestInterceptor`](../../mozilla.components.concept.engine.request/-request-interceptor/index.md) | + +### Functions + +| Name | Summary | +|---|---| +| [beginAuthentication](begin-authentication.md) | `fun beginAuthentication(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.feature.accounts/-firefox-accounts-auth-feature/interceptor.md b/docs/api/mozilla.components.feature.accounts/-firefox-accounts-auth-feature/interceptor.md new file mode 100644 index 00000000000..377e0432aff --- /dev/null +++ b/docs/api/mozilla.components.feature.accounts/-firefox-accounts-auth-feature/interceptor.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.accounts](../index.md) / [FirefoxAccountsAuthFeature](index.md) / [interceptor](./interceptor.md) + +# interceptor + +`val interceptor: `[`RequestInterceptor`](../../mozilla.components.concept.engine.request/-request-interceptor/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/accounts/src/main/java/mozilla/components/feature/accounts/FirefoxAccountsAuthFeature.kt#L47) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.accounts/index.md b/docs/api/mozilla.components.feature.accounts/index.md new file mode 100644 index 00000000000..91ed0195dc0 --- /dev/null +++ b/docs/api/mozilla.components.feature.accounts/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.feature.accounts](./index.md) + +## Package mozilla.components.feature.accounts + +### Types + +| Name | Summary | +|---|---| +| [FirefoxAccountsAuthFeature](-firefox-accounts-auth-feature/index.md) | `class FirefoxAccountsAuthFeature`
Ties together an account manager with a session manager/tabs implementation, facilitating an authentication flow. | diff --git a/docs/api/mozilla.components.feature.awesomebar.provider/-clipboard-suggestion-provider/-init-.md b/docs/api/mozilla.components.feature.awesomebar.provider/-clipboard-suggestion-provider/-init-.md new file mode 100644 index 00000000000..3d2f5b05d68 --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar.provider/-clipboard-suggestion-provider/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar.provider](../index.md) / [ClipboardSuggestionProvider](index.md) / [<init>](./-init-.md) + +# <init> + +`ClipboardSuggestionProvider(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, loadUrlUseCase: `[`LoadUrlUseCase`](../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md)`, icon: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`? = null, title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)` + +An [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that returns a suggestions for an URL in the clipboard (if there's +any). + diff --git a/docs/api/mozilla.components.feature.awesomebar.provider/-clipboard-suggestion-provider/index.md b/docs/api/mozilla.components.feature.awesomebar.provider/-clipboard-suggestion-provider/index.md new file mode 100644 index 00000000000..ba697f9a96f --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar.provider/-clipboard-suggestion-provider/index.md @@ -0,0 +1,33 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar.provider](../index.md) / [ClipboardSuggestionProvider](./index.md) + +# ClipboardSuggestionProvider + +`class ClipboardSuggestionProvider : `[`SuggestionProvider`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/provider/ClipboardSuggestionProvider.kt#L21) + +An [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that returns a suggestions for an URL in the clipboard (if there's +any). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ClipboardSuggestionProvider(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, loadUrlUseCase: `[`LoadUrlUseCase`](../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md)`, icon: `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`? = null, title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)`
An [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that returns a suggestions for an URL in the clipboard (if there's any). | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [shouldClearSuggestions](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/should-clear-suggestions.md) | `open val shouldClearSuggestions: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
If true an [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation can clear the previous suggestions of this provider as soon as the user continues to type. If this is false an [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation is allowed to keep the previous suggestions around until the provider returns a new list of suggestions for the updated text. | + +### Functions + +| Name | Summary | +|---|---| +| [onInputChanged](on-input-changed.md) | `suspend fun onInputChanged(text: `[`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)`<`[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`>`
Fired whenever the user changes their input, after they have started interacting with the awesome bar. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [onInputCancelled](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-cancelled.md) | `open fun onInputCancelled(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Fired when the user has cancelled their interaction with the awesome bar. | +| [onInputStarted](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-started.md) | `open fun onInputStarted(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Fired when the user starts interacting with the awesome bar by entering text in the toolbar. | diff --git a/docs/api/mozilla.components.feature.awesomebar.provider/-clipboard-suggestion-provider/on-input-changed.md b/docs/api/mozilla.components.feature.awesomebar.provider/-clipboard-suggestion-provider/on-input-changed.md new file mode 100644 index 00000000000..6e16a5f2973 --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar.provider/-clipboard-suggestion-provider/on-input-changed.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar.provider](../index.md) / [ClipboardSuggestionProvider](index.md) / [onInputChanged](./on-input-changed.md) + +# onInputChanged + +`suspend fun onInputChanged(text: `[`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)`<`[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/provider/ClipboardSuggestionProvider.kt#L29) + +Overrides [SuggestionProvider.onInputChanged](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-changed.md) + +Fired whenever the user changes their input, after they have started interacting with the awesome bar. + +This is a suspending function. An [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation is expected to invoke this method from a +[Coroutine](https://kotlinlang.org/docs/reference/coroutines-overview.html). This allows the [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) +implementation to group and cancel calls to multiple providers. + +Coroutine cancellation is cooperative. A coroutine code has to cooperate to be cancellable: +https://github.com/Kotlin/kotlinx.coroutines/blob/master/docs/cancellation-and-timeouts.md + +### Parameters + +`text` - The current user input in the toolbar. + +**Return** +A list of suggestions to be displayed by the [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md). + diff --git a/docs/api/mozilla.components.feature.awesomebar.provider/-history-storage-suggestion-provider/-init-.md b/docs/api/mozilla.components.feature.awesomebar.provider/-history-storage-suggestion-provider/-init-.md new file mode 100644 index 00000000000..0bbd5aaa5f8 --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar.provider/-history-storage-suggestion-provider/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar.provider](../index.md) / [HistoryStorageSuggestionProvider](index.md) / [<init>](./-init-.md) + +# <init> + +`HistoryStorageSuggestionProvider(historyStorage: `[`HistoryStorage`](../../mozilla.components.concept.storage/-history-storage/index.md)`, loadUrlUseCase: `[`LoadUrlUseCase`](../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md)`)` + +A [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that provides suggestions based on the browsing +history stored in the [HistoryStorage](../../mozilla.components.concept.storage/-history-storage/index.md). + diff --git a/docs/api/mozilla.components.feature.awesomebar.provider/-history-storage-suggestion-provider/index.md b/docs/api/mozilla.components.feature.awesomebar.provider/-history-storage-suggestion-provider/index.md new file mode 100644 index 00000000000..20784b56955 --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar.provider/-history-storage-suggestion-provider/index.md @@ -0,0 +1,33 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar.provider](../index.md) / [HistoryStorageSuggestionProvider](./index.md) + +# HistoryStorageSuggestionProvider + +`class HistoryStorageSuggestionProvider : `[`SuggestionProvider`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/provider/HistoryStorageSuggestionProvider.kt#L18) + +A [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that provides suggestions based on the browsing +history stored in the [HistoryStorage](../../mozilla.components.concept.storage/-history-storage/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `HistoryStorageSuggestionProvider(historyStorage: `[`HistoryStorage`](../../mozilla.components.concept.storage/-history-storage/index.md)`, loadUrlUseCase: `[`LoadUrlUseCase`](../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md)`)`
A [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that provides suggestions based on the browsing history stored in the [HistoryStorage](../../mozilla.components.concept.storage/-history-storage/index.md). | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [shouldClearSuggestions](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/should-clear-suggestions.md) | `open val shouldClearSuggestions: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
If true an [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation can clear the previous suggestions of this provider as soon as the user continues to type. If this is false an [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation is allowed to keep the previous suggestions around until the provider returns a new list of suggestions for the updated text. | + +### Functions + +| Name | Summary | +|---|---| +| [onInputChanged](on-input-changed.md) | `suspend fun onInputChanged(text: `[`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)`<`[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`>`
Fired whenever the user changes their input, after they have started interacting with the awesome bar. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [onInputCancelled](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-cancelled.md) | `open fun onInputCancelled(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Fired when the user has cancelled their interaction with the awesome bar. | +| [onInputStarted](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-started.md) | `open fun onInputStarted(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Fired when the user starts interacting with the awesome bar by entering text in the toolbar. | diff --git a/docs/api/mozilla.components.feature.awesomebar.provider/-history-storage-suggestion-provider/on-input-changed.md b/docs/api/mozilla.components.feature.awesomebar.provider/-history-storage-suggestion-provider/on-input-changed.md new file mode 100644 index 00000000000..d3c879d50ab --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar.provider/-history-storage-suggestion-provider/on-input-changed.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar.provider](../index.md) / [HistoryStorageSuggestionProvider](index.md) / [onInputChanged](./on-input-changed.md) + +# onInputChanged + +`suspend fun onInputChanged(text: `[`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)`<`[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/provider/HistoryStorageSuggestionProvider.kt#L23) + +Overrides [SuggestionProvider.onInputChanged](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-changed.md) + +Fired whenever the user changes their input, after they have started interacting with the awesome bar. + +This is a suspending function. An [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation is expected to invoke this method from a +[Coroutine](https://kotlinlang.org/docs/reference/coroutines-overview.html). This allows the [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) +implementation to group and cancel calls to multiple providers. + +Coroutine cancellation is cooperative. A coroutine code has to cooperate to be cancellable: +https://github.com/Kotlin/kotlinx.coroutines/blob/master/docs/cancellation-and-timeouts.md + +### Parameters + +`text` - The current user input in the toolbar. + +**Return** +A list of suggestions to be displayed by the [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md). + diff --git a/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-init-.md b/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-init-.md new file mode 100644 index 00000000000..df98aab2a8d --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar.provider](../index.md) / [SearchSuggestionProvider](index.md) / [<init>](./-init-.md) + +# <init> + +`SearchSuggestionProvider(searchEngine: `[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.md)`, searchUseCase: `[`SearchUseCase`](../../mozilla.components.feature.search/-search-use-cases/-search-use-case/index.md)`, mode: `[`Mode`](-mode/index.md)` = Mode.SINGLE_SUGGESTION)` + +A [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that provides a suggestion containing search engine suggestions (as +chips) from the passed in [SearchEngine](../../mozilla.components.browser.search/-search-engine/index.md). + diff --git a/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-mode/-m-u-l-t-i-p-l-e_-s-u-g-g-e-s-t-i-o-n-s.md b/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-mode/-m-u-l-t-i-p-l-e_-s-u-g-g-e-s-t-i-o-n-s.md new file mode 100644 index 00000000000..290ac0dfcd2 --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-mode/-m-u-l-t-i-p-l-e_-s-u-g-g-e-s-t-i-o-n-s.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.feature.awesomebar.provider](../../index.md) / [SearchSuggestionProvider](../index.md) / [Mode](index.md) / [MULTIPLE_SUGGESTIONS](./-m-u-l-t-i-p-l-e_-s-u-g-g-e-s-t-i-o-n-s.md) + +# MULTIPLE_SUGGESTIONS + +`MULTIPLE_SUGGESTIONS` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/provider/SearchSuggestionProvider.kt#L125) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-mode/-s-i-n-g-l-e_-s-u-g-g-e-s-t-i-o-n.md b/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-mode/-s-i-n-g-l-e_-s-u-g-g-e-s-t-i-o-n.md new file mode 100644 index 00000000000..0a6640a57fe --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-mode/-s-i-n-g-l-e_-s-u-g-g-e-s-t-i-o-n.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.feature.awesomebar.provider](../../index.md) / [SearchSuggestionProvider](../index.md) / [Mode](index.md) / [SINGLE_SUGGESTION](./-s-i-n-g-l-e_-s-u-g-g-e-s-t-i-o-n.md) + +# SINGLE_SUGGESTION + +`SINGLE_SUGGESTION` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/provider/SearchSuggestionProvider.kt#L124) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-mode/index.md b/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-mode/index.md new file mode 100644 index 00000000000..2aa75d7bf2b --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-mode/index.md @@ -0,0 +1,12 @@ +[android-components](../../../index.md) / [mozilla.components.feature.awesomebar.provider](../../index.md) / [SearchSuggestionProvider](../index.md) / [Mode](./index.md) + +# Mode + +`enum class Mode` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/provider/SearchSuggestionProvider.kt#L123) + +### Enum Values + +| Name | Summary | +|---|---| +| [SINGLE_SUGGESTION](-s-i-n-g-l-e_-s-u-g-g-e-s-t-i-o-n.md) | | +| [MULTIPLE_SUGGESTIONS](-m-u-l-t-i-p-l-e_-s-u-g-g-e-s-t-i-o-n-s.md) | | diff --git a/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/index.md b/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/index.md new file mode 100644 index 00000000000..64d066fdf29 --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/index.md @@ -0,0 +1,39 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar.provider](../index.md) / [SearchSuggestionProvider](./index.md) + +# SearchSuggestionProvider + +`class SearchSuggestionProvider : `[`SuggestionProvider`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/provider/SearchSuggestionProvider.kt#L20) + +A [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that provides a suggestion containing search engine suggestions (as +chips) from the passed in [SearchEngine](../../mozilla.components.browser.search/-search-engine/index.md). + +### Types + +| Name | Summary | +|---|---| +| [Mode](-mode/index.md) | `enum class Mode` | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SearchSuggestionProvider(searchEngine: `[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.md)`, searchUseCase: `[`SearchUseCase`](../../mozilla.components.feature.search/-search-use-cases/-search-use-case/index.md)`, mode: `[`Mode`](-mode/index.md)` = Mode.SINGLE_SUGGESTION)`
A [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that provides a suggestion containing search engine suggestions (as chips) from the passed in [SearchEngine](../../mozilla.components.browser.search/-search-engine/index.md). | + +### Properties + +| Name | Summary | +|---|---| +| [shouldClearSuggestions](should-clear-suggestions.md) | `val shouldClearSuggestions: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
If true an [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation can clear the previous suggestions of this provider as soon as the user continues to type. If this is false an [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation is allowed to keep the previous suggestions around until the provider returns a new list of suggestions for the updated text. | + +### Functions + +| Name | Summary | +|---|---| +| [onInputChanged](on-input-changed.md) | `suspend fun onInputChanged(text: `[`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)`<`[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`>`
Fired whenever the user changes their input, after they have started interacting with the awesome bar. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [onInputCancelled](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-cancelled.md) | `open fun onInputCancelled(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Fired when the user has cancelled their interaction with the awesome bar. | +| [onInputStarted](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-started.md) | `open fun onInputStarted(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Fired when the user starts interacting with the awesome bar by entering text in the toolbar. | diff --git a/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/on-input-changed.md b/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/on-input-changed.md new file mode 100644 index 00000000000..d470c71038a --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/on-input-changed.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar.provider](../index.md) / [SearchSuggestionProvider](index.md) / [onInputChanged](./on-input-changed.md) + +# onInputChanged + +`suspend fun onInputChanged(text: `[`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)`<`[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/provider/SearchSuggestionProvider.kt#L34) + +Overrides [SuggestionProvider.onInputChanged](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-changed.md) + +Fired whenever the user changes their input, after they have started interacting with the awesome bar. + +This is a suspending function. An [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation is expected to invoke this method from a +[Coroutine](https://kotlinlang.org/docs/reference/coroutines-overview.html). This allows the [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) +implementation to group and cancel calls to multiple providers. + +Coroutine cancellation is cooperative. A coroutine code has to cooperate to be cancellable: +https://github.com/Kotlin/kotlinx.coroutines/blob/master/docs/cancellation-and-timeouts.md + +### Parameters + +`text` - The current user input in the toolbar. + +**Return** +A list of suggestions to be displayed by the [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md). + diff --git a/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/should-clear-suggestions.md b/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/should-clear-suggestions.md new file mode 100644 index 00000000000..f165db80354 --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/should-clear-suggestions.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar.provider](../index.md) / [SearchSuggestionProvider](index.md) / [shouldClearSuggestions](./should-clear-suggestions.md) + +# shouldClearSuggestions + +`val shouldClearSuggestions: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/provider/SearchSuggestionProvider.kt#L119) + +Overrides [SuggestionProvider.shouldClearSuggestions](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/should-clear-suggestions.md) + +If true an [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation can clear the previous suggestions of this provider as soon as the +user continues to type. If this is false an [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation is allowed to keep the previous +suggestions around until the provider returns a new list of suggestions for the updated text. + diff --git a/docs/api/mozilla.components.feature.awesomebar.provider/-session-suggestion-provider/-init-.md b/docs/api/mozilla.components.feature.awesomebar.provider/-session-suggestion-provider/-init-.md new file mode 100644 index 00000000000..b17c96ec03e --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar.provider/-session-suggestion-provider/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar.provider](../index.md) / [SessionSuggestionProvider](index.md) / [<init>](./-init-.md) + +# <init> + +`SessionSuggestionProvider(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, selectTabUseCase: `[`SelectTabUseCase`](../../mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/index.md)`)` + +A [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that provides suggestions based on the sessions in the +[SessionManager](../../mozilla.components.browser.session/-session-manager/index.md) (Open tabs). + diff --git a/docs/api/mozilla.components.feature.awesomebar.provider/-session-suggestion-provider/index.md b/docs/api/mozilla.components.feature.awesomebar.provider/-session-suggestion-provider/index.md new file mode 100644 index 00000000000..4c7cacf1cd8 --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar.provider/-session-suggestion-provider/index.md @@ -0,0 +1,33 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar.provider](../index.md) / [SessionSuggestionProvider](./index.md) + +# SessionSuggestionProvider + +`class SessionSuggestionProvider : `[`SuggestionProvider`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/provider/SessionSuggestionProvider.kt#L15) + +A [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that provides suggestions based on the sessions in the +[SessionManager](../../mozilla.components.browser.session/-session-manager/index.md) (Open tabs). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SessionSuggestionProvider(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, selectTabUseCase: `[`SelectTabUseCase`](../../mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/index.md)`)`
A [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that provides suggestions based on the sessions in the [SessionManager](../../mozilla.components.browser.session/-session-manager/index.md) (Open tabs). | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [shouldClearSuggestions](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/should-clear-suggestions.md) | `open val shouldClearSuggestions: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
If true an [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation can clear the previous suggestions of this provider as soon as the user continues to type. If this is false an [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation is allowed to keep the previous suggestions around until the provider returns a new list of suggestions for the updated text. | + +### Functions + +| Name | Summary | +|---|---| +| [onInputChanged](on-input-changed.md) | `suspend fun onInputChanged(text: `[`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)`<`[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`>`
Fired whenever the user changes their input, after they have started interacting with the awesome bar. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [onInputCancelled](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-cancelled.md) | `open fun onInputCancelled(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Fired when the user has cancelled their interaction with the awesome bar. | +| [onInputStarted](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-started.md) | `open fun onInputStarted(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Fired when the user starts interacting with the awesome bar by entering text in the toolbar. | diff --git a/docs/api/mozilla.components.feature.awesomebar.provider/-session-suggestion-provider/on-input-changed.md b/docs/api/mozilla.components.feature.awesomebar.provider/-session-suggestion-provider/on-input-changed.md new file mode 100644 index 00000000000..407eccac9d4 --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar.provider/-session-suggestion-provider/on-input-changed.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar.provider](../index.md) / [SessionSuggestionProvider](index.md) / [onInputChanged](./on-input-changed.md) + +# onInputChanged + +`suspend fun onInputChanged(text: `[`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)`<`[`Suggestion`](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/provider/SessionSuggestionProvider.kt#L19) + +Overrides [SuggestionProvider.onInputChanged](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/on-input-changed.md) + +Fired whenever the user changes their input, after they have started interacting with the awesome bar. + +This is a suspending function. An [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) implementation is expected to invoke this method from a +[Coroutine](https://kotlinlang.org/docs/reference/coroutines-overview.html). This allows the [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) +implementation to group and cancel calls to multiple providers. + +Coroutine cancellation is cooperative. A coroutine code has to cooperate to be cancellable: +https://github.com/Kotlin/kotlinx.coroutines/blob/master/docs/cancellation-and-timeouts.md + +### Parameters + +`text` - The current user input in the toolbar. + +**Return** +A list of suggestions to be displayed by the [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md). + diff --git a/docs/api/mozilla.components.feature.awesomebar.provider/index.md b/docs/api/mozilla.components.feature.awesomebar.provider/index.md new file mode 100644 index 00000000000..1478e331965 --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar.provider/index.md @@ -0,0 +1,12 @@ +[android-components](../index.md) / [mozilla.components.feature.awesomebar.provider](./index.md) + +## Package mozilla.components.feature.awesomebar.provider + +### Types + +| Name | Summary | +|---|---| +| [ClipboardSuggestionProvider](-clipboard-suggestion-provider/index.md) | `class ClipboardSuggestionProvider : `[`SuggestionProvider`](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md)
An [AwesomeBar.SuggestionProvider](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that returns a suggestions for an URL in the clipboard (if there's any). | +| [HistoryStorageSuggestionProvider](-history-storage-suggestion-provider/index.md) | `class HistoryStorageSuggestionProvider : `[`SuggestionProvider`](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md)
A [AwesomeBar.SuggestionProvider](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that provides suggestions based on the browsing history stored in the [HistoryStorage](../mozilla.components.concept.storage/-history-storage/index.md). | +| [SearchSuggestionProvider](-search-suggestion-provider/index.md) | `class SearchSuggestionProvider : `[`SuggestionProvider`](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md)
A [AwesomeBar.SuggestionProvider](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that provides a suggestion containing search engine suggestions (as chips) from the passed in [SearchEngine](../mozilla.components.browser.search/-search-engine/index.md). | +| [SessionSuggestionProvider](-session-suggestion-provider/index.md) | `class SessionSuggestionProvider : `[`SuggestionProvider`](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md)
A [AwesomeBar.SuggestionProvider](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementation that provides suggestions based on the sessions in the [SessionManager](../mozilla.components.browser.session/-session-manager/index.md) (Open tabs). | diff --git a/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/-init-.md b/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/-init-.md new file mode 100644 index 00000000000..8918d5477d7 --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar](../index.md) / [AwesomeBarFeature](index.md) / [<init>](./-init-.md) + +# <init> + +`AwesomeBarFeature(awesomeBar: `[`AwesomeBar`](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md)`, toolbar: `[`Toolbar`](../../mozilla.components.concept.toolbar/-toolbar/index.md)`, engineView: `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md)`? = null, onEditStart: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null, onEditComplete: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null)` + +Connects an [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) with a [Toolbar](../../mozilla.components.concept.toolbar/-toolbar/index.md) and allows adding multiple [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementations. + diff --git a/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/add-clipboard-provider.md b/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/add-clipboard-provider.md new file mode 100644 index 00000000000..7e5e4d7ea9d --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/add-clipboard-provider.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar](../index.md) / [AwesomeBarFeature](index.md) / [addClipboardProvider](./add-clipboard-provider.md) + +# addClipboardProvider + +`fun addClipboardProvider(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, loadUrlUseCase: `[`LoadUrlUseCase`](../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md)`): `[`AwesomeBarFeature`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/AwesomeBarFeature.kt#L87) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/add-history-provider.md b/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/add-history-provider.md new file mode 100644 index 00000000000..1eddaa9361a --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/add-history-provider.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar](../index.md) / [AwesomeBarFeature](index.md) / [addHistoryProvider](./add-history-provider.md) + +# addHistoryProvider + +`fun addHistoryProvider(historyStorage: `[`HistoryStorage`](../../mozilla.components.concept.storage/-history-storage/index.md)`, loadUrlUseCase: `[`LoadUrlUseCase`](../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md)`): `[`AwesomeBarFeature`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/AwesomeBarFeature.kt#L79) + +Add a [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) for browsing history to the [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md). + diff --git a/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/add-search-provider.md b/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/add-search-provider.md new file mode 100644 index 00000000000..3d71c6dc55d --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/add-search-provider.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar](../index.md) / [AwesomeBarFeature](index.md) / [addSearchProvider](./add-search-provider.md) + +# addSearchProvider + +`fun addSearchProvider(searchEngine: `[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.md)`, searchUseCase: `[`SearchUseCase`](../../mozilla.components.feature.search/-search-use-cases/-search-use-case/index.md)`, mode: `[`Mode`](../../mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-mode/index.md)` = SearchSuggestionProvider.Mode.SINGLE_SUGGESTION): `[`AwesomeBarFeature`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/AwesomeBarFeature.kt#L67) + +Add a [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) for search engine suggestions to the [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md). + diff --git a/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/add-session-provider.md b/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/add-session-provider.md new file mode 100644 index 00000000000..cc45c2fe2ea --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/add-session-provider.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar](../index.md) / [AwesomeBarFeature](index.md) / [addSessionProvider](./add-session-provider.md) + +# addSessionProvider + +`fun addSessionProvider(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, selectTabUseCase: `[`SelectTabUseCase`](../../mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/index.md)`): `[`AwesomeBarFeature`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/AwesomeBarFeature.kt#L55) + +Add a [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) for "Open tabs" to the [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md). + diff --git a/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/index.md b/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/index.md new file mode 100644 index 00000000000..b2213bdd28f --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar/-awesome-bar-feature/index.md @@ -0,0 +1,22 @@ +[android-components](../../index.md) / [mozilla.components.feature.awesomebar](../index.md) / [AwesomeBarFeature](./index.md) + +# AwesomeBarFeature + +`class AwesomeBarFeature` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/awesomebar/src/main/java/mozilla/components/feature/awesomebar/AwesomeBarFeature.kt#L26) + +Connects an [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) with a [Toolbar](../../mozilla.components.concept.toolbar/-toolbar/index.md) and allows adding multiple [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementations. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AwesomeBarFeature(awesomeBar: `[`AwesomeBar`](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md)`, toolbar: `[`Toolbar`](../../mozilla.components.concept.toolbar/-toolbar/index.md)`, engineView: `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md)`? = null, onEditStart: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null, onEditComplete: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null)`
Connects an [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md) with a [Toolbar](../../mozilla.components.concept.toolbar/-toolbar/index.md) and allows adding multiple [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementations. | + +### Functions + +| Name | Summary | +|---|---| +| [addClipboardProvider](add-clipboard-provider.md) | `fun addClipboardProvider(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, loadUrlUseCase: `[`LoadUrlUseCase`](../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md)`): `[`AwesomeBarFeature`](./index.md) | +| [addHistoryProvider](add-history-provider.md) | `fun addHistoryProvider(historyStorage: `[`HistoryStorage`](../../mozilla.components.concept.storage/-history-storage/index.md)`, loadUrlUseCase: `[`LoadUrlUseCase`](../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md)`): `[`AwesomeBarFeature`](./index.md)
Add a [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) for browsing history to the [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md). | +| [addSearchProvider](add-search-provider.md) | `fun addSearchProvider(searchEngine: `[`SearchEngine`](../../mozilla.components.browser.search/-search-engine/index.md)`, searchUseCase: `[`SearchUseCase`](../../mozilla.components.feature.search/-search-use-cases/-search-use-case/index.md)`, mode: `[`Mode`](../../mozilla.components.feature.awesomebar.provider/-search-suggestion-provider/-mode/index.md)` = SearchSuggestionProvider.Mode.SINGLE_SUGGESTION): `[`AwesomeBarFeature`](./index.md)
Add a [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) for search engine suggestions to the [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md). | +| [addSessionProvider](add-session-provider.md) | `fun addSessionProvider(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, selectTabUseCase: `[`SelectTabUseCase`](../../mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/index.md)`): `[`AwesomeBarFeature`](./index.md)
Add a [AwesomeBar.SuggestionProvider](../../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) for "Open tabs" to the [AwesomeBar](../../mozilla.components.concept.awesomebar/-awesome-bar/index.md). | diff --git a/docs/api/mozilla.components.feature.awesomebar/index.md b/docs/api/mozilla.components.feature.awesomebar/index.md new file mode 100644 index 00000000000..cca37b7791d --- /dev/null +++ b/docs/api/mozilla.components.feature.awesomebar/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.feature.awesomebar](./index.md) + +## Package mozilla.components.feature.awesomebar + +### Types + +| Name | Summary | +|---|---| +| [AwesomeBarFeature](-awesome-bar-feature/index.md) | `class AwesomeBarFeature`
Connects an [AwesomeBar](../mozilla.components.concept.awesomebar/-awesome-bar/index.md) with a [Toolbar](../mozilla.components.concept.toolbar/-toolbar/index.md) and allows adding multiple [AwesomeBar.SuggestionProvider](../mozilla.components.concept.awesomebar/-awesome-bar/-suggestion-provider/index.md) implementations. | diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/-init-.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/-init-.md new file mode 100644 index 00000000000..f3712787fdc --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuCandidate](index.md) / [<init>](./-init-.md) + +# <init> + +`ContextMenuCandidate(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, showFor: (`[`Session`](../../mozilla.components.browser.session/-session/index.md)`, `[`HitResult`](../../mozilla.components.concept.engine/-hit-result/index.md)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, action: (`[`Session`](../../mozilla.components.browser.session/-session/index.md)`, `[`HitResult`](../../mozilla.components.concept.engine/-hit-result/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +A candidate for an item to be displayed in the context menu. + diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/action.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/action.md new file mode 100644 index 00000000000..0018b7ac425 --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/action.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuCandidate](index.md) / [action](./action.md) + +# action + +`val action: (`[`Session`](../../mozilla.components.browser.session/-session/index.md)`, `[`HitResult`](../../mozilla.components.concept.engine/-hit-result/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuCandidate.kt#L34) + +The action to be invoked once the user selects this item. + +### Property + +`action` - The action to be invoked once the user selects this item. \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-copy-image-location-candidate.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-copy-image-location-candidate.md new file mode 100644 index 00000000000..8181fed6046 --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-copy-image-location-candidate.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuCandidate](index.md) / [createCopyImageLocationCandidate](./create-copy-image-location-candidate.md) + +# createCopyImageLocationCandidate + +`fun createCopyImageLocationCandidate(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, snackBarParentView: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`ContextMenuCandidate`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuCandidate.kt#L208) + +Context Menu item: "Copy Image Location". + diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-copy-link-candidate.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-copy-link-candidate.md new file mode 100644 index 00000000000..4f2c657a15c --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-copy-link-candidate.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuCandidate](index.md) / [createCopyLinkCandidate](./create-copy-link-candidate.md) + +# createCopyLinkCandidate + +`fun createCopyLinkCandidate(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, snackBarParentView: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`ContextMenuCandidate`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuCandidate.kt#L185) + +Context Menu item: "Copy Link". + diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-open-image-in-new-tab-candidate.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-open-image-in-new-tab-candidate.md new file mode 100644 index 00000000000..ba1ef1dbeb1 --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-open-image-in-new-tab-candidate.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuCandidate](index.md) / [createOpenImageInNewTabCandidate](./create-open-image-in-new-tab-candidate.md) + +# createOpenImageInNewTabCandidate + +`fun createOpenImageInNewTabCandidate(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, tabsUseCases: `[`TabsUseCases`](../../mozilla.components.feature.tabs/-tabs-use-cases/index.md)`, snackBarParentView: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`ContextMenuCandidate`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuCandidate.kt#L113) + +Context Menu item: "Open Image in New Tab". + diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-open-in-new-tab-candidate.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-open-in-new-tab-candidate.md new file mode 100644 index 00000000000..b27ae50f764 --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-open-in-new-tab-candidate.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuCandidate](index.md) / [createOpenInNewTabCandidate](./create-open-in-new-tab-candidate.md) + +# createOpenInNewTabCandidate + +`fun createOpenInNewTabCandidate(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, tabsUseCases: `[`TabsUseCases`](../../mozilla.components.feature.tabs/-tabs-use-cases/index.md)`, snackBarParentView: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`ContextMenuCandidate`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuCandidate.kt#L61) + +Context Menu item: "Open Link in New Tab". + diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-open-in-private-tab-candidate.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-open-in-private-tab-candidate.md new file mode 100644 index 00000000000..fd53f14e200 --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-open-in-private-tab-candidate.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuCandidate](index.md) / [createOpenInPrivateTabCandidate](./create-open-in-private-tab-candidate.md) + +# createOpenInPrivateTabCandidate + +`fun createOpenInPrivateTabCandidate(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, tabsUseCases: `[`TabsUseCases`](../../mozilla.components.feature.tabs/-tabs-use-cases/index.md)`, snackBarParentView: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`ContextMenuCandidate`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuCandidate.kt#L87) + +Context Menu item: "Open Link in Private Tab". + diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-save-image-candidate.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-save-image-candidate.md new file mode 100644 index 00000000000..cbc3638641f --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-save-image-candidate.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuCandidate](index.md) / [createSaveImageCandidate](./create-save-image-candidate.md) + +# createSaveImageCandidate + +`fun createSaveImageCandidate(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`ContextMenuCandidate`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuCandidate.kt#L144) + +Context Menu item: "Save image". + diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-share-link-candidate.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-share-link-candidate.md new file mode 100644 index 00000000000..e53a344f803 --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/create-share-link-candidate.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuCandidate](index.md) / [createShareLinkCandidate](./create-share-link-candidate.md) + +# createShareLinkCandidate + +`fun createShareLinkCandidate(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`ContextMenuCandidate`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuCandidate.kt#L160) + +Context Menu item: "Share Link". + diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/default-candidates.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/default-candidates.md new file mode 100644 index 00000000000..5c490720e63 --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/default-candidates.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuCandidate](index.md) / [defaultCandidates](./default-candidates.md) + +# defaultCandidates + +`fun defaultCandidates(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, tabsUseCases: `[`TabsUseCases`](../../mozilla.components.feature.tabs/-tabs-use-cases/index.md)`, snackBarParentView: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`ContextMenuCandidate`](index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuCandidate.kt#L44) + +Returns the default list of context menu candidates. + +Use this list if you do not intend to customize the context menu items to be displayed. + diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/id.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/id.md new file mode 100644 index 00000000000..f83e88929b8 --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/id.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuCandidate](index.md) / [id](./id.md) + +# id + +`val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuCandidate.kt#L31) + +A unique ID that will be used to uniquely identify the candidate that the user selected. + +### Property + +`id` - A unique ID that will be used to uniquely identify the candidate that the user selected. \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/index.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/index.md new file mode 100644 index 00000000000..b441bfec3ed --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/index.md @@ -0,0 +1,35 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuCandidate](./index.md) + +# ContextMenuCandidate + +`data class ContextMenuCandidate` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuCandidate.kt#L30) + +A candidate for an item to be displayed in the context menu. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContextMenuCandidate(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, showFor: (`[`Session`](../../mozilla.components.browser.session/-session/index.md)`, `[`HitResult`](../../mozilla.components.concept.engine/-hit-result/index.md)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, action: (`[`Session`](../../mozilla.components.browser.session/-session/index.md)`, `[`HitResult`](../../mozilla.components.concept.engine/-hit-result/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
A candidate for an item to be displayed in the context menu. | + +### Properties + +| Name | Summary | +|---|---| +| [action](action.md) | `val action: (`[`Session`](../../mozilla.components.browser.session/-session/index.md)`, `[`HitResult`](../../mozilla.components.concept.engine/-hit-result/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
The action to be invoked once the user selects this item. | +| [id](id.md) | `val id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
A unique ID that will be used to uniquely identify the candidate that the user selected. | +| [label](label.md) | `val label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The label that will be displayed in the context menu | +| [showFor](show-for.md) | `val showFor: (`[`Session`](../../mozilla.components.browser.session/-session/index.md)`, `[`HitResult`](../../mozilla.components.concept.engine/-hit-result/index.md)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
If this lambda returns true for a given [Session](../../mozilla.components.browser.session/-session/index.md) and [HitResult](../../mozilla.components.concept.engine/-hit-result/index.md) then it will be displayed in the context menu. | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [createCopyImageLocationCandidate](create-copy-image-location-candidate.md) | `fun createCopyImageLocationCandidate(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, snackBarParentView: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`ContextMenuCandidate`](./index.md)
Context Menu item: "Copy Image Location". | +| [createCopyLinkCandidate](create-copy-link-candidate.md) | `fun createCopyLinkCandidate(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, snackBarParentView: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`ContextMenuCandidate`](./index.md)
Context Menu item: "Copy Link". | +| [createOpenImageInNewTabCandidate](create-open-image-in-new-tab-candidate.md) | `fun createOpenImageInNewTabCandidate(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, tabsUseCases: `[`TabsUseCases`](../../mozilla.components.feature.tabs/-tabs-use-cases/index.md)`, snackBarParentView: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`ContextMenuCandidate`](./index.md)
Context Menu item: "Open Image in New Tab". | +| [createOpenInNewTabCandidate](create-open-in-new-tab-candidate.md) | `fun createOpenInNewTabCandidate(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, tabsUseCases: `[`TabsUseCases`](../../mozilla.components.feature.tabs/-tabs-use-cases/index.md)`, snackBarParentView: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`ContextMenuCandidate`](./index.md)
Context Menu item: "Open Link in New Tab". | +| [createOpenInPrivateTabCandidate](create-open-in-private-tab-candidate.md) | `fun createOpenInPrivateTabCandidate(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, tabsUseCases: `[`TabsUseCases`](../../mozilla.components.feature.tabs/-tabs-use-cases/index.md)`, snackBarParentView: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`ContextMenuCandidate`](./index.md)
Context Menu item: "Open Link in Private Tab". | +| [createSaveImageCandidate](create-save-image-candidate.md) | `fun createSaveImageCandidate(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`ContextMenuCandidate`](./index.md)
Context Menu item: "Save image". | +| [createShareLinkCandidate](create-share-link-candidate.md) | `fun createShareLinkCandidate(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`ContextMenuCandidate`](./index.md)
Context Menu item: "Share Link". | +| [defaultCandidates](default-candidates.md) | `fun defaultCandidates(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, tabsUseCases: `[`TabsUseCases`](../../mozilla.components.feature.tabs/-tabs-use-cases/index.md)`, snackBarParentView: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`ContextMenuCandidate`](./index.md)`>`
Returns the default list of context menu candidates. | diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/label.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/label.md new file mode 100644 index 00000000000..2552d0eb5b1 --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/label.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuCandidate](index.md) / [label](./label.md) + +# label + +`val label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuCandidate.kt#L32) + +The label that will be displayed in the context menu + +### Property + +`label` - The label that will be displayed in the context menu \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/show-for.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/show-for.md new file mode 100644 index 00000000000..c3035d56b26 --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-candidate/show-for.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuCandidate](index.md) / [showFor](./show-for.md) + +# showFor + +`val showFor: (`[`Session`](../../mozilla.components.browser.session/-session/index.md)`, `[`HitResult`](../../mozilla.components.concept.engine/-hit-result/index.md)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuCandidate.kt#L33) + +If this lambda returns true for a given [Session](../../mozilla.components.browser.session/-session/index.md) and [HitResult](../../mozilla.components.concept.engine/-hit-result/index.md) then it will be displayed in the +context menu. + +### Property + +`showFor` - If this lambda returns true for a given [Session](../../mozilla.components.browser.session/-session/index.md) and [HitResult](../../mozilla.components.concept.engine/-hit-result/index.md) then it will be displayed in the +context menu. \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-feature/-init-.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-feature/-init-.md new file mode 100644 index 00000000000..e96accdb5c9 --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-feature/-init-.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuFeature](index.md) / [<init>](./-init-.md) + +# <init> + +`ContextMenuFeature(fragmentManager: FragmentManager, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, candidates: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`ContextMenuCandidate`](../-context-menu-candidate/index.md)`>, engineView: `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md)`, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)` + +Feature for displaying a context menu after long-pressing web content. + +This feature will subscribe to the currently selected [Session](../../mozilla.components.browser.session/-session/index.md) and display the context menu based on +[Session.Observer.onLongPress](../../mozilla.components.browser.session/-session/-observer/on-long-press.md) events. Once the context menu is closed or the user selects an item from the context +menu the related [HitResult](../../mozilla.components.concept.engine/-hit-result/index.md) will be consumed. + diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-feature/index.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-feature/index.md new file mode 100644 index 00000000000..502c73c8b77 --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-feature/index.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuFeature](./index.md) + +# ContextMenuFeature + +`class ContextMenuFeature : `[`LifecycleAwareFeature`](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuFeature.kt#L35) + +Feature for displaying a context menu after long-pressing web content. + +This feature will subscribe to the currently selected [Session](../../mozilla.components.browser.session/-session/index.md) and display the context menu based on +[Session.Observer.onLongPress](../../mozilla.components.browser.session/-session/-observer/on-long-press.md) events. Once the context menu is closed or the user selects an item from the context +menu the related [HitResult](../../mozilla.components.concept.engine/-hit-result/index.md) will be consumed. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContextMenuFeature(fragmentManager: FragmentManager, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, candidates: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`ContextMenuCandidate`](../-context-menu-candidate/index.md)`>, engineView: `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md)`, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)`
Feature for displaying a context menu after long-pressing web content. | + +### Functions + +| Name | Summary | +|---|---| +| [start](start.md) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Start observing the selected session and when needed show a context menu. | +| [stop](stop.md) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stop observing the selected session and do not show any context menus anymore. | diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-feature/start.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-feature/start.md new file mode 100644 index 00000000000..fec7dbb1a24 --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-feature/start.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuFeature](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuFeature.kt#L47) + +Overrides [LifecycleAwareFeature.start](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/start.md) + +Start observing the selected session and when needed show a context menu. + diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-feature/stop.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-feature/stop.md new file mode 100644 index 00000000000..7521f4875be --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-feature/stop.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuFeature](index.md) / [stop](./stop.md) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuFeature.kt#L61) + +Overrides [LifecycleAwareFeature.stop](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/stop.md) + +Stop observing the selected session and do not show any context menus anymore. + diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-fragment/-init-.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-fragment/-init-.md new file mode 100644 index 00000000000..6187cf96378 --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-fragment/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuFragment](index.md) / [<init>](./-init-.md) + +# <init> + +`ContextMenuFragment()` + +[DialogFragment](#) implementation to display the actual context menu dialog. + diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-fragment/create.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-fragment/create.md new file mode 100644 index 00000000000..0efc7a6d351 --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-fragment/create.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuFragment](index.md) / [create](./create.md) + +# create + +`fun create(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, ids: `[`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)`>, labels: `[`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)`>): `[`ContextMenuFragment`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuFragment.kt#L83) + +Create a new [ContextMenuFragment](index.md). + diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-fragment/index.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-fragment/index.md new file mode 100644 index 00000000000..fb8bc63f9b1 --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-fragment/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuFragment](./index.md) + +# ContextMenuFragment + +`class ContextMenuFragment : DialogFragment` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuFragment.kt#L30) + +[DialogFragment](#) implementation to display the actual context menu dialog. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContextMenuFragment()`
[DialogFragment](#) implementation to display the actual context menu dialog. | + +### Functions + +| Name | Summary | +|---|---| +| [onCreateDialog](on-create-dialog.md) | `fun onCreateDialog(savedInstanceState: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?): `[`Dialog`](https://developer.android.com/reference/android/app/Dialog.html) | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [create](create.md) | `fun create(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, ids: `[`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)`>, labels: `[`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)`>): `[`ContextMenuFragment`](./index.md)
Create a new [ContextMenuFragment](./index.md). | diff --git a/docs/api/mozilla.components.feature.contextmenu/-context-menu-fragment/on-create-dialog.md b/docs/api/mozilla.components.feature.contextmenu/-context-menu-fragment/on-create-dialog.md new file mode 100644 index 00000000000..8260a02403a --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/-context-menu-fragment/on-create-dialog.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.contextmenu](../index.md) / [ContextMenuFragment](index.md) / [onCreateDialog](./on-create-dialog.md) + +# onCreateDialog + +`fun onCreateDialog(savedInstanceState: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?): `[`Dialog`](https://developer.android.com/reference/android/app/Dialog.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/contextmenu/src/main/java/mozilla/components/feature/contextmenu/ContextMenuFragment.kt#L38) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.contextmenu/index.md b/docs/api/mozilla.components.feature.contextmenu/index.md new file mode 100644 index 00000000000..eed7871b5b3 --- /dev/null +++ b/docs/api/mozilla.components.feature.contextmenu/index.md @@ -0,0 +1,11 @@ +[android-components](../index.md) / [mozilla.components.feature.contextmenu](./index.md) + +## Package mozilla.components.feature.contextmenu + +### Types + +| Name | Summary | +|---|---| +| [ContextMenuCandidate](-context-menu-candidate/index.md) | `data class ContextMenuCandidate`
A candidate for an item to be displayed in the context menu. | +| [ContextMenuFeature](-context-menu-feature/index.md) | `class ContextMenuFeature : `[`LifecycleAwareFeature`](../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)
Feature for displaying a context menu after long-pressing web content. | +| [ContextMenuFragment](-context-menu-fragment/index.md) | `class ContextMenuFragment : DialogFragment`
[DialogFragment](#) implementation to display the actual context menu dialog. | diff --git a/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/-init-.md b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/-init-.md new file mode 100644 index 00000000000..8a9033dff27 --- /dev/null +++ b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.customtabs](../index.md) / [AbstractCustomTabsService](index.md) / [<init>](./-init-.md) + +# <init> + +`AbstractCustomTabsService()` + +[Service](https://developer.android.com/reference/android/app/Service.html) providing Custom Tabs related functionality. + diff --git a/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/engine.md b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/engine.md new file mode 100644 index 00000000000..5050d98be8e --- /dev/null +++ b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/engine.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.customtabs](../index.md) / [AbstractCustomTabsService](index.md) / [engine](./engine.md) + +# engine + +`abstract val engine: `[`Engine`](../../mozilla.components.concept.engine/-engine/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/customtabs/src/main/java/mozilla/components/feature/customtabs/AbstractCustomTabsService.kt#L29) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/extra-command.md b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/extra-command.md new file mode 100644 index 00000000000..fd9f502d8ce --- /dev/null +++ b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/extra-command.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.customtabs](../index.md) / [AbstractCustomTabsService](index.md) / [extraCommand](./extra-command.md) + +# extraCommand + +`protected open fun extraCommand(commandName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, args: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?): `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/customtabs/src/main/java/mozilla/components/feature/customtabs/AbstractCustomTabsService.kt#L48) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/index.md b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/index.md new file mode 100644 index 00000000000..557569f49d3 --- /dev/null +++ b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/index.md @@ -0,0 +1,47 @@ +[android-components](../../index.md) / [mozilla.components.feature.customtabs](../index.md) / [AbstractCustomTabsService](./index.md) + +# AbstractCustomTabsService + +`abstract class AbstractCustomTabsService : CustomTabsService` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/customtabs/src/main/java/mozilla/components/feature/customtabs/AbstractCustomTabsService.kt#L26) + +[Service](https://developer.android.com/reference/android/app/Service.html) providing Custom Tabs related functionality. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AbstractCustomTabsService()`
[Service](https://developer.android.com/reference/android/app/Service.html) providing Custom Tabs related functionality. | + +### Properties + +| Name | Summary | +|---|---| +| [engine](engine.md) | `abstract val engine: `[`Engine`](../../mozilla.components.concept.engine/-engine/index.md) | + +### Functions + +| Name | Summary | +|---|---| +| [extraCommand](extra-command.md) | `open fun extraCommand(commandName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, args: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?): `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?` | +| [mayLaunchUrl](may-launch-url.md) | `open fun mayLaunchUrl(sessionToken: CustomTabsSessionToken?, url: `[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`?, extras: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?, otherLikelyBundles: `[`MutableList`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`<`[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`>?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [newSession](new-session.md) | `open fun newSession(sessionToken: CustomTabsSessionToken?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [postMessage](post-message.md) | `open fun postMessage(sessionToken: CustomTabsSessionToken?, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, extras: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [requestPostMessageChannel](request-post-message-channel.md) | `open fun requestPostMessageChannel(sessionToken: CustomTabsSessionToken?, postMessageOrigin: `[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [updateVisuals](update-visuals.md) | `open fun updateVisuals(sessionToken: CustomTabsSessionToken?, bundle: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [validateRelationship](validate-relationship.md) | `open fun validateRelationship(sessionToken: CustomTabsSessionToken?, relation: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, origin: `[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`?, extras: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [warmup](warmup.md) | `open fun warmup(flags: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Extension Properties + +| Name | Summary | +|---|---| +| [appVersionName](../../mozilla.components.support.ktx.android.content/android.content.-context/app-version-name.md) | `val `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.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". | + +### Extension Functions + +| Name | Summary | +|---|---| +| [isOSOnLowMemory](../../mozilla.components.support.ktx.android.content/android.content.-context/is-o-s-on-low-memory.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.isOSOnLowMemory(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns whether or not the operating system is under low memory conditions. | +| [isPermissionGranted](../../mozilla.components.support.ktx.android.content/android.content.-context/is-permission-granted.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.isPermissionGranted(vararg permission: `[`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 if a list of permission have been granted, if all the permission have been granted returns true otherwise false. | +| [share](../../mozilla.components.support.ktx.android.content/android.content.-context/share.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.share(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, subject: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getString(R.string.mozac_support_ktx_share_dialog_title)): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Shares content via [ACTION_SEND](https://developer.android.com/reference/android/content/Intent.html#ACTION_SEND) intent. | +| [systemService](../../mozilla.components.support.ktx.android.content/android.content.-context/system-service.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.systemService(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](../../mozilla.components.support.ktx.android.content/android.content.-context/system-service.md#T)
Returns the handle to a system-level service by name. | diff --git a/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/may-launch-url.md b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/may-launch-url.md new file mode 100644 index 00000000000..2ed07d3c865 --- /dev/null +++ b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/may-launch-url.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.customtabs](../index.md) / [AbstractCustomTabsService](index.md) / [mayLaunchUrl](./may-launch-url.md) + +# mayLaunchUrl + +`protected open fun mayLaunchUrl(sessionToken: CustomTabsSessionToken?, url: `[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`?, extras: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?, otherLikelyBundles: `[`MutableList`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`<`[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`>?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/customtabs/src/main/java/mozilla/components/feature/customtabs/AbstractCustomTabsService.kt#L52) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/new-session.md b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/new-session.md new file mode 100644 index 00000000000..5b70b6c698e --- /dev/null +++ b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/new-session.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.customtabs](../index.md) / [AbstractCustomTabsService](index.md) / [newSession](./new-session.md) + +# newSession + +`protected open fun newSession(sessionToken: CustomTabsSessionToken?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/customtabs/src/main/java/mozilla/components/feature/customtabs/AbstractCustomTabsService.kt#L44) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/post-message.md b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/post-message.md new file mode 100644 index 00000000000..e4ee9a45b7d --- /dev/null +++ b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/post-message.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.customtabs](../index.md) / [AbstractCustomTabsService](index.md) / [postMessage](./post-message.md) + +# postMessage + +`protected open fun postMessage(sessionToken: CustomTabsSessionToken?, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, extras: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/customtabs/src/main/java/mozilla/components/feature/customtabs/AbstractCustomTabsService.kt#L73) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/request-post-message-channel.md b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/request-post-message-channel.md new file mode 100644 index 00000000000..e730f4ee702 --- /dev/null +++ b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/request-post-message-channel.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.customtabs](../index.md) / [AbstractCustomTabsService](index.md) / [requestPostMessageChannel](./request-post-message-channel.md) + +# requestPostMessageChannel + +`protected open fun requestPostMessageChannel(sessionToken: CustomTabsSessionToken?, postMessageOrigin: `[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/customtabs/src/main/java/mozilla/components/feature/customtabs/AbstractCustomTabsService.kt#L40) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/update-visuals.md b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/update-visuals.md new file mode 100644 index 00000000000..783d696a643 --- /dev/null +++ b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/update-visuals.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.customtabs](../index.md) / [AbstractCustomTabsService](index.md) / [updateVisuals](./update-visuals.md) + +# updateVisuals + +`protected open fun updateVisuals(sessionToken: CustomTabsSessionToken?, bundle: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/customtabs/src/main/java/mozilla/components/feature/customtabs/AbstractCustomTabsService.kt#L86) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/validate-relationship.md b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/validate-relationship.md new file mode 100644 index 00000000000..acf187a8502 --- /dev/null +++ b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/validate-relationship.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.customtabs](../index.md) / [AbstractCustomTabsService](index.md) / [validateRelationship](./validate-relationship.md) + +# validateRelationship + +`protected open fun validateRelationship(sessionToken: CustomTabsSessionToken?, relation: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, origin: `[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`?, extras: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/customtabs/src/main/java/mozilla/components/feature/customtabs/AbstractCustomTabsService.kt#L77) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/warmup.md b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/warmup.md new file mode 100644 index 00000000000..60a9a038b0c --- /dev/null +++ b/docs/api/mozilla.components.feature.customtabs/-abstract-custom-tabs-service/warmup.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.customtabs](../index.md) / [AbstractCustomTabsService](index.md) / [warmup](./warmup.md) + +# warmup + +`protected open fun warmup(flags: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/customtabs/src/main/java/mozilla/components/feature/customtabs/AbstractCustomTabsService.kt#L31) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/-init-.md b/docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/-init-.md new file mode 100644 index 00000000000..55e5145333f --- /dev/null +++ b/docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.customtabs](../index.md) / [CustomTabsToolbarFeature](index.md) / [<init>](./-init-.md) + +# <init> + +`CustomTabsToolbarFeature(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, toolbar: `[`BrowserToolbar`](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md)`, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, menuBuilder: `[`BrowserMenuBuilder`](../../mozilla.components.browser.menu/-browser-menu-builder/index.md)`? = null, shareListener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null, closeListener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +Initializes and resets the Toolbar for a Custom Tab based on the CustomTabConfig. + diff --git a/docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/index.md b/docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/index.md new file mode 100644 index 00000000000..5455e3e71b8 --- /dev/null +++ b/docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/index.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.feature.customtabs](../index.md) / [CustomTabsToolbarFeature](./index.md) + +# CustomTabsToolbarFeature + +`class CustomTabsToolbarFeature : `[`LifecycleAwareFeature`](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)`, `[`BackHandler`](../../mozilla.components.support.base.feature/-back-handler/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/customtabs/src/main/java/mozilla/components/feature/customtabs/CustomTabsToolbarFeature.kt#L30) + +Initializes and resets the Toolbar for a Custom Tab based on the CustomTabConfig. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `CustomTabsToolbarFeature(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, toolbar: `[`BrowserToolbar`](../../mozilla.components.browser.toolbar/-browser-toolbar/index.md)`, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, menuBuilder: `[`BrowserMenuBuilder`](../../mozilla.components.browser.menu/-browser-menu-builder/index.md)`? = null, shareListener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null, closeListener: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
Initializes and resets the Toolbar for a Custom Tab based on the CustomTabConfig. | + +### Functions + +| Name | Summary | +|---|---| +| [onBackPressed](on-back-pressed.md) | `fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Removes the current Custom Tabs session when the back button is pressed and returns true. Should be called when the back button is pressed. | +| [start](start.md) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [stop](stop.md) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/on-back-pressed.md b/docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/on-back-pressed.md new file mode 100644 index 00000000000..59eb450a68d --- /dev/null +++ b/docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/on-back-pressed.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.feature.customtabs](../index.md) / [CustomTabsToolbarFeature](index.md) / [onBackPressed](./on-back-pressed.md) + +# onBackPressed + +`fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/customtabs/src/main/java/mozilla/components/feature/customtabs/CustomTabsToolbarFeature.kt#L143) + +Overrides [BackHandler.onBackPressed](../../mozilla.components.support.base.feature/-back-handler/on-back-pressed.md) + +Removes the current Custom Tabs session when the back button is pressed and returns true. +Should be called when the back button is pressed. + diff --git a/docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/start.md b/docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/start.md new file mode 100644 index 00000000000..1b5e23a74b6 --- /dev/null +++ b/docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/start.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.customtabs](../index.md) / [CustomTabsToolbarFeature](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/customtabs/src/main/java/mozilla/components/feature/customtabs/CustomTabsToolbarFeature.kt#L42) + +Overrides [LifecycleAwareFeature.start](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/start.md) + diff --git a/docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/stop.md b/docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/stop.md new file mode 100644 index 00000000000..8808eb648da --- /dev/null +++ b/docs/api/mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/stop.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.customtabs](../index.md) / [CustomTabsToolbarFeature](index.md) / [stop](./stop.md) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/customtabs/src/main/java/mozilla/components/feature/customtabs/CustomTabsToolbarFeature.kt#L137) + +Overrides [LifecycleAwareFeature.stop](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/stop.md) + diff --git a/docs/api/mozilla.components.feature.customtabs/index.md b/docs/api/mozilla.components.feature.customtabs/index.md new file mode 100644 index 00000000000..1daac41caab --- /dev/null +++ b/docs/api/mozilla.components.feature.customtabs/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.feature.customtabs](./index.md) + +## Package mozilla.components.feature.customtabs + +### Types + +| Name | Summary | +|---|---| +| [AbstractCustomTabsService](-abstract-custom-tabs-service/index.md) | `abstract class AbstractCustomTabsService : CustomTabsService`
[Service](https://developer.android.com/reference/android/app/Service.html) providing Custom Tabs related functionality. | +| [CustomTabsToolbarFeature](-custom-tabs-toolbar-feature/index.md) | `class CustomTabsToolbarFeature : `[`LifecycleAwareFeature`](../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)`, `[`BackHandler`](../mozilla.components.support.base.feature/-back-handler/index.md)
Initializes and resets the Toolbar for a Custom Tab based on the CustomTabConfig. | diff --git a/docs/api/mozilla.components.feature.downloads/-android-download-manager.md b/docs/api/mozilla.components.feature.downloads/-android-download-manager.md new file mode 100644 index 00000000000..a69f8ec118d --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-android-download-manager.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.feature.downloads](index.md) / [AndroidDownloadManager](./-android-download-manager.md) + +# AndroidDownloadManager + +`typealias AndroidDownloadManager = `[`DownloadManager`](https://developer.android.com/reference/android/app/DownloadManager.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadManager.kt#L25) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-f-r-a-g-m-e-n-t_-t-a-g.md b/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-f-r-a-g-m-e-n-t_-t-a-g.md new file mode 100644 index 00000000000..0c3db67483a --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-f-r-a-g-m-e-n-t_-t-a-g.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadDialogFragment](index.md) / [FRAGMENT_TAG](./-f-r-a-g-m-e-n-t_-t-a-g.md) + +# FRAGMENT_TAG + +`const val FRAGMENT_TAG: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadDialogFragment.kt#L50) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-init-.md b/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-init-.md new file mode 100644 index 00000000000..e1907069494 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-init-.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadDialogFragment](index.md) / [<init>](./-init-.md) + +# <init> + +`DownloadDialogFragment()` + +This is a general representation of a dialog meant to be used in collaboration with [DownloadsFeature](../-downloads-feature/index.md) +to show a dialog before a download is triggered. +If [SimpleDownloadDialogFragment](../-simple-download-dialog-fragment/index.md) is not flexible enough for your use case you should inherit for this class. +Be mindful to call [onStartDownload](on-start-download.md) when you want to start the download. + diff --git a/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-k-e-y_-c-o-n-t-e-n-t_-l-e-n-g-t-h.md b/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-k-e-y_-c-o-n-t-e-n-t_-l-e-n-g-t-h.md new file mode 100644 index 00000000000..a6b027c9390 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-k-e-y_-c-o-n-t-e-n-t_-l-e-n-g-t-h.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadDialogFragment](index.md) / [KEY_CONTENT_LENGTH](./-k-e-y_-c-o-n-t-e-n-t_-l-e-n-g-t-h.md) + +# KEY_CONTENT_LENGTH + +`const val KEY_CONTENT_LENGTH: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadDialogFragment.kt#L44) + +Key for finding the content length in the arguments. + diff --git a/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-k-e-y_-f-i-l-e_-n-a-m-e.md b/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-k-e-y_-f-i-l-e_-n-a-m-e.md new file mode 100644 index 00000000000..f0d603b7dd6 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-k-e-y_-f-i-l-e_-n-a-m-e.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadDialogFragment](index.md) / [KEY_FILE_NAME](./-k-e-y_-f-i-l-e_-n-a-m-e.md) + +# KEY_FILE_NAME + +`const val KEY_FILE_NAME: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadDialogFragment.kt#L40) + +Key for finding the file name in the arguments. + diff --git a/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-k-e-y_-u-r-l.md b/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-k-e-y_-u-r-l.md new file mode 100644 index 00000000000..7d27584db3f --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/-k-e-y_-u-r-l.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadDialogFragment](index.md) / [KEY_URL](./-k-e-y_-u-r-l.md) + +# KEY_URL + +`const val KEY_URL: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadDialogFragment.kt#L48) + +Key for finding the url in the arguments. + diff --git a/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/index.md b/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/index.md new file mode 100644 index 00000000000..50d446fae32 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/index.md @@ -0,0 +1,43 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadDialogFragment](./index.md) + +# DownloadDialogFragment + +`abstract class DownloadDialogFragment : DialogFragment` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadDialogFragment.kt#L16) + +This is a general representation of a dialog meant to be used in collaboration with [DownloadsFeature](../-downloads-feature/index.md) +to show a dialog before a download is triggered. +If [SimpleDownloadDialogFragment](../-simple-download-dialog-fragment/index.md) is not flexible enough for your use case you should inherit for this class. +Be mindful to call [onStartDownload](on-start-download.md) when you want to start the download. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `DownloadDialogFragment()`
This is a general representation of a dialog meant to be used in collaboration with [DownloadsFeature](../-downloads-feature/index.md) to show a dialog before a download is triggered. If [SimpleDownloadDialogFragment](../-simple-download-dialog-fragment/index.md) is not flexible enough for your use case you should inherit for this class. Be mindful to call [onStartDownload](on-start-download.md) when you want to start the download. | + +### Properties + +| Name | Summary | +|---|---| +| [onStartDownload](on-start-download.md) | `var onStartDownload: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
A callback to trigger a download, call it when you are ready to start a download. For instance, a valid use case can be in confirmation dialog, after the positive button is clicked, this callback must be called. | + +### Functions + +| Name | Summary | +|---|---| +| [setDownload](set-download.md) | `fun setDownload(download: `[`Download`](../../mozilla.components.browser.session/-download/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
add the metadata of this download object to the arguments of this fragment. | + +### Companion Object Properties + +| Name | Summary | +|---|---| +| [FRAGMENT_TAG](-f-r-a-g-m-e-n-t_-t-a-g.md) | `const val FRAGMENT_TAG: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [KEY_CONTENT_LENGTH](-k-e-y_-c-o-n-t-e-n-t_-l-e-n-g-t-h.md) | `const val KEY_CONTENT_LENGTH: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Key for finding the content length in the arguments. | +| [KEY_FILE_NAME](-k-e-y_-f-i-l-e_-n-a-m-e.md) | `const val KEY_FILE_NAME: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Key for finding the file name in the arguments. | +| [KEY_URL](-k-e-y_-u-r-l.md) | `const val KEY_URL: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Key for finding the url in the arguments. | + +### Inheritors + +| Name | Summary | +|---|---| +| [SimpleDownloadDialogFragment](../-simple-download-dialog-fragment/index.md) | `class SimpleDownloadDialogFragment : `[`DownloadDialogFragment`](./index.md)
A confirmation dialog to be called before a download is triggered. Meant to be used in collaboration with [DownloadsFeature](../-downloads-feature/index.md) | diff --git a/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/on-start-download.md b/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/on-start-download.md new file mode 100644 index 00000000000..3027b5614de --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/on-start-download.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadDialogFragment](index.md) / [onStartDownload](./on-start-download.md) + +# onStartDownload + +`var onStartDownload: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadDialogFragment.kt#L23) + +A callback to trigger a download, call it when you are ready to start a download. For instance, +a valid use case can be in confirmation dialog, after the positive button is clicked, +this callback must be called. + diff --git a/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/set-download.md b/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/set-download.md new file mode 100644 index 00000000000..66f3be203da --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-download-dialog-fragment/set-download.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadDialogFragment](index.md) / [setDownload](./set-download.md) + +# setDownload + +`fun setDownload(download: `[`Download`](../../mozilla.components.browser.session/-download/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadDialogFragment.kt#L28) + +add the metadata of this download object to the arguments of this fragment. + diff --git a/docs/api/mozilla.components.feature.downloads/-download-manager/-init-.md b/docs/api/mozilla.components.feature.downloads/-download-manager/-init-.md new file mode 100644 index 00000000000..c94fdcce290 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-download-manager/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadManager](index.md) / [<init>](./-init-.md) + +# <init> + +`DownloadManager(applicationContext: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, onDownloadCompleted: `[`OnDownloadCompleted`](../-on-download-completed.md)` = { _, _ -> })` + +Handles the interactions with the [AndroidDownloadManager](../-android-download-manager.md). + diff --git a/docs/api/mozilla.components.feature.downloads/-download-manager/download.md b/docs/api/mozilla.components.feature.downloads/-download-manager/download.md new file mode 100644 index 00000000000..732d1741a2e --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-download-manager/download.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadManager](index.md) / [download](./download.md) + +# download + +`fun download(download: `[`Download`](../../mozilla.components.browser.session/-download/index.md)`, refererURL: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "", cookie: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = ""): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadManager.kt#L49) + +Schedule a download through the [AndroidDownloadManager](../-android-download-manager.md). + +### Parameters + +`download` - metadata related to the download. + +`refererURL` - the url from where this download was referred. + +`cookie` - any additional cookie to add as part of the download request. + +**Return** +the id reference of the scheduled download. + diff --git a/docs/api/mozilla.components.feature.downloads/-download-manager/index.md b/docs/api/mozilla.components.feature.downloads/-download-manager/index.md new file mode 100644 index 00000000000..4b509d6dab2 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-download-manager/index.md @@ -0,0 +1,26 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadManager](./index.md) + +# DownloadManager + +`class DownloadManager` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadManager.kt#L32) + +Handles the interactions with the [AndroidDownloadManager](../-android-download-manager.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `DownloadManager(applicationContext: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, onDownloadCompleted: `[`OnDownloadCompleted`](../-on-download-completed.md)` = { _, _ -> })`
Handles the interactions with the [AndroidDownloadManager](../-android-download-manager.md). | + +### Properties + +| Name | Summary | +|---|---| +| [onDownloadCompleted](on-download-completed.md) | `var onDownloadCompleted: `[`OnDownloadCompleted`](../-on-download-completed.md)
a callback to be notified when a download is completed. | + +### Functions + +| Name | Summary | +|---|---| +| [download](download.md) | `fun download(download: `[`Download`](../../mozilla.components.browser.session/-download/index.md)`, refererURL: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "", cookie: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = ""): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Schedule a download through the [AndroidDownloadManager](../-android-download-manager.md). | +| [unregisterListener](unregister-listener.md) | `fun unregisterListener(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Remove all the listeners. | diff --git a/docs/api/mozilla.components.feature.downloads/-download-manager/on-download-completed.md b/docs/api/mozilla.components.feature.downloads/-download-manager/on-download-completed.md new file mode 100644 index 00000000000..0fc3cfb0304 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-download-manager/on-download-completed.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadManager](index.md) / [onDownloadCompleted](./on-download-completed.md) + +# onDownloadCompleted + +`var onDownloadCompleted: `[`OnDownloadCompleted`](../-on-download-completed.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadManager.kt#L34) + +a callback to be notified when a download is completed. + +### Property + +`onDownloadCompleted` - a callback to be notified when a download is completed. \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.downloads/-download-manager/unregister-listener.md b/docs/api/mozilla.components.feature.downloads/-download-manager/unregister-listener.md new file mode 100644 index 00000000000..a29fc610928 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-download-manager/unregister-listener.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadManager](index.md) / [unregisterListener](./unregister-listener.md) + +# unregisterListener + +`fun unregisterListener(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadManager.kt#L91) + +Remove all the listeners. + diff --git a/docs/api/mozilla.components.feature.downloads/-downloads-feature/-init-.md b/docs/api/mozilla.components.feature.downloads/-downloads-feature/-init-.md new file mode 100644 index 00000000000..35917e7c862 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-downloads-feature/-init-.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadsFeature](index.md) / [<init>](./-init-.md) + +# <init> + +`DownloadsFeature(applicationContext: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, onNeedToRequestPermissions: `[`OnNeedToRequestPermissions`](../-on-need-to-request-permissions.md)` = { }, onDownloadCompleted: `[`OnDownloadCompleted`](../-on-download-completed.md)` = { _, _ -> }, downloadManager: `[`DownloadManager`](../-download-manager/index.md)` = DownloadManager(applicationContext, onDownloadCompleted), sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, fragmentManager: FragmentManager? = null, dialog: `[`DownloadDialogFragment`](../-download-dialog-fragment/index.md)` = SimpleDownloadDialogFragment.newInstance())` + +Feature implementation to provide download functionality for the selected +session. The feature will subscribe to the selected session and listen +for downloads. + diff --git a/docs/api/mozilla.components.feature.downloads/-downloads-feature/index.md b/docs/api/mozilla.components.feature.downloads/-downloads-feature/index.md new file mode 100644 index 00000000000..28da1ed5c6f --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-downloads-feature/index.md @@ -0,0 +1,45 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadsFeature](./index.md) + +# DownloadsFeature + +`class DownloadsFeature : `[`SelectionAwareSessionObserver`](../../mozilla.components.browser.session/-selection-aware-session-observer/index.md)`, `[`LifecycleAwareFeature`](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadsFeature.kt#L41) + +Feature implementation to provide download functionality for the selected +session. The feature will subscribe to the selected session and listen +for downloads. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `DownloadsFeature(applicationContext: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, onNeedToRequestPermissions: `[`OnNeedToRequestPermissions`](../-on-need-to-request-permissions.md)` = { }, onDownloadCompleted: `[`OnDownloadCompleted`](../-on-download-completed.md)` = { _, _ -> }, downloadManager: `[`DownloadManager`](../-download-manager/index.md)` = DownloadManager(applicationContext, onDownloadCompleted), sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, fragmentManager: FragmentManager? = null, dialog: `[`DownloadDialogFragment`](../-download-dialog-fragment/index.md)` = SimpleDownloadDialogFragment.newInstance())`
Feature implementation to provide download functionality for the selected session. The feature will subscribe to the selected session and listen for downloads. | + +### Properties + +| Name | Summary | +|---|---| +| [onDownloadCompleted](on-download-completed.md) | `var onDownloadCompleted: `[`OnDownloadCompleted`](../-on-download-completed.md)
a callback invoked when a download is completed. | +| [onNeedToRequestPermissions](on-need-to-request-permissions.md) | `var onNeedToRequestPermissions: `[`OnNeedToRequestPermissions`](../-on-need-to-request-permissions.md)
a callback invoked when permissions need to be requested before a download can be performed. Once the request is completed, [onPermissionsResult](on-permissions-result.md) needs to be invoked. | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [activeSession](../../mozilla.components.browser.session/-selection-aware-session-observer/active-session.md) | `open var activeSession: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`?`
the currently observed session | + +### Functions + +| Name | Summary | +|---|---| +| [onDownload](on-download.md) | `fun onDownload(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, download: `[`Download`](../../mozilla.components.browser.session/-download/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Notifies the [DownloadManager](../-download-manager/index.md) that a new download must be processed. | +| [onPermissionsResult](on-permissions-result.md) | `fun onPermissionsResult(permissions: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>, grantResults: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Notifies the feature that the permissions request was completed. It will then either trigger or clear the pending download. | +| [start](start.md) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts observing downloads on the selected session and sends them to the [DownloadManager](../-download-manager/index.md) to be processed. | +| [stop](stop.md) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stops observing downloads on the selected session. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [observeFixed](../../mozilla.components.browser.session/-selection-aware-session-observer/observe-fixed.md) | `fun observeFixed(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts observing changes to the specified session. | +| [observeSelected](../../mozilla.components.browser.session/-selection-aware-session-observer/observe-selected.md) | `fun observeSelected(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts observing changes to the selected session (see [SessionManager.selectedSession](../../mozilla.components.browser.session/-session-manager/selected-session.md)). If a different session is selected the observer will automatically be switched over and only notified of changes to the newly selected session. | +| [onSessionSelected](../../mozilla.components.browser.session/-selection-aware-session-observer/on-session-selected.md) | `open fun onSessionSelected(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`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/mozilla.components.feature.downloads/-downloads-feature/on-download-completed.md b/docs/api/mozilla.components.feature.downloads/-downloads-feature/on-download-completed.md new file mode 100644 index 00000000000..0af793b21e2 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-downloads-feature/on-download-completed.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadsFeature](index.md) / [onDownloadCompleted](./on-download-completed.md) + +# onDownloadCompleted + +`var onDownloadCompleted: `[`OnDownloadCompleted`](../-on-download-completed.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadsFeature.kt#L44) + +a callback invoked when a download is completed. + +### Property + +`onDownloadCompleted` - a callback invoked when a download is completed. \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.downloads/-downloads-feature/on-download.md b/docs/api/mozilla.components.feature.downloads/-downloads-feature/on-download.md new file mode 100644 index 00000000000..89972a7bc3b --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-downloads-feature/on-download.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadsFeature](index.md) / [onDownload](./on-download.md) + +# onDownload + +`fun onDownload(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, download: `[`Download`](../../mozilla.components.browser.session/-download/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadsFeature.kt#L77) + +Overrides [Observer.onDownload](../../mozilla.components.browser.session/-session/-observer/on-download.md) + +Notifies the [DownloadManager](../-download-manager/index.md) that a new download must be processed. + diff --git a/docs/api/mozilla.components.feature.downloads/-downloads-feature/on-need-to-request-permissions.md b/docs/api/mozilla.components.feature.downloads/-downloads-feature/on-need-to-request-permissions.md new file mode 100644 index 00000000000..8c46b40e49c --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-downloads-feature/on-need-to-request-permissions.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadsFeature](index.md) / [onNeedToRequestPermissions](./on-need-to-request-permissions.md) + +# onNeedToRequestPermissions + +`var onNeedToRequestPermissions: `[`OnNeedToRequestPermissions`](../-on-need-to-request-permissions.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadsFeature.kt#L43) + +a callback invoked when permissions +need to be requested before a download can be performed. Once the request +is completed, [onPermissionsResult](on-permissions-result.md) needs to be invoked. + +### Property + +`onNeedToRequestPermissions` - a callback invoked when permissions +need to be requested before a download can be performed. Once the request +is completed, [onPermissionsResult](on-permissions-result.md) needs to be invoked. \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.downloads/-downloads-feature/on-permissions-result.md b/docs/api/mozilla.components.feature.downloads/-downloads-feature/on-permissions-result.md new file mode 100644 index 00000000000..76208876d0c --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-downloads-feature/on-permissions-result.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadsFeature](index.md) / [onPermissionsResult](./on-permissions-result.md) + +# onPermissionsResult + +`fun onPermissionsResult(permissions: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>, grantResults: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadsFeature.kt#L96) + +Notifies the feature that the permissions request was completed. It will then +either trigger or clear the pending download. + diff --git a/docs/api/mozilla.components.feature.downloads/-downloads-feature/start.md b/docs/api/mozilla.components.feature.downloads/-downloads-feature/start.md new file mode 100644 index 00000000000..ef1c97e5752 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-downloads-feature/start.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadsFeature](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadsFeature.kt#L56) + +Overrides [LifecycleAwareFeature.start](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/start.md) + +Starts observing downloads on the selected session and sends them to the [DownloadManager](../-download-manager/index.md) +to be processed. + diff --git a/docs/api/mozilla.components.feature.downloads/-downloads-feature/stop.md b/docs/api/mozilla.components.feature.downloads/-downloads-feature/stop.md new file mode 100644 index 00000000000..ef93f1c09b6 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-downloads-feature/stop.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [DownloadsFeature](index.md) / [stop](./stop.md) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadsFeature.kt#L68) + +Overrides [SelectionAwareSessionObserver.stop](../../mozilla.components.browser.session/-selection-aware-session-observer/stop.md) + +Overrides [LifecycleAwareFeature.stop](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/stop.md) + +Stops observing downloads on the selected session. + diff --git a/docs/api/mozilla.components.feature.downloads/-on-download-completed.md b/docs/api/mozilla.components.feature.downloads/-on-download-completed.md new file mode 100644 index 00000000000..13a13fdf505 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-on-download-completed.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.feature.downloads](index.md) / [OnDownloadCompleted](./-on-download-completed.md) + +# OnDownloadCompleted + +`typealias OnDownloadCompleted = (`[`Download`](../mozilla.components.browser.session/-download/index.md)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadManager.kt#L24) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.downloads/-on-need-to-request-permissions.md b/docs/api/mozilla.components.feature.downloads/-on-need-to-request-permissions.md new file mode 100644 index 00000000000..1e027ec11af --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-on-need-to-request-permissions.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.feature.downloads](index.md) / [OnNeedToRequestPermissions](./-on-need-to-request-permissions.md) + +# OnNeedToRequestPermissions + +`typealias OnNeedToRequestPermissions = (permissions: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/DownloadsFeature.kt#L21) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-init-.md b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-init-.md new file mode 100644 index 00000000000..066bec79b7e --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-init-.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [SimpleDownloadDialogFragment](index.md) / [<init>](./-init-.md) + +# <init> + +`SimpleDownloadDialogFragment()` + +A confirmation dialog to be called before a download is triggered. +Meant to be used in collaboration with [DownloadsFeature](../-downloads-feature/index.md) + +[SimpleDownloadDialogFragment](index.md) is the default dialog use by DownloadsFeature if you don't provide a value. +It is composed by a title, a negative and a positive bottoms. When the positive button is clicked +the download it triggered. + diff --git a/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-c-a-n-c-e-l-a-b-l-e.md b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-c-a-n-c-e-l-a-b-l-e.md new file mode 100644 index 00000000000..dd7a59adeb9 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-c-a-n-c-e-l-a-b-l-e.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [SimpleDownloadDialogFragment](index.md) / [KEY_CANCELABLE](./-k-e-y_-c-a-n-c-e-l-a-b-l-e.md) + +# KEY_CANCELABLE + +`const val KEY_CANCELABLE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/SimpleDownloadDialogFragment.kt#L98) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-n-e-g-a-t-i-v-e_-t-e-x-t.md b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-n-e-g-a-t-i-v-e_-t-e-x-t.md new file mode 100644 index 00000000000..b3db6cda86e --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-n-e-g-a-t-i-v-e_-t-e-x-t.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [SimpleDownloadDialogFragment](index.md) / [KEY_NEGATIVE_TEXT](./-k-e-y_-n-e-g-a-t-i-v-e_-t-e-x-t.md) + +# KEY_NEGATIVE_TEXT + +`const val KEY_NEGATIVE_TEXT: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/SimpleDownloadDialogFragment.kt#L92) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-p-o-s-i-t-i-v-e_-t-e-x-t.md b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-p-o-s-i-t-i-v-e_-t-e-x-t.md new file mode 100644 index 00000000000..f1c9f21550f --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-p-o-s-i-t-i-v-e_-t-e-x-t.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [SimpleDownloadDialogFragment](index.md) / [KEY_POSITIVE_TEXT](./-k-e-y_-p-o-s-i-t-i-v-e_-t-e-x-t.md) + +# KEY_POSITIVE_TEXT + +`const val KEY_POSITIVE_TEXT: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/SimpleDownloadDialogFragment.kt#L90) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-t-h-e-m-e_-i-d.md b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-t-h-e-m-e_-i-d.md new file mode 100644 index 00000000000..a5c1a23c829 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-t-h-e-m-e_-i-d.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [SimpleDownloadDialogFragment](index.md) / [KEY_THEME_ID](./-k-e-y_-t-h-e-m-e_-i-d.md) + +# KEY_THEME_ID + +`const val KEY_THEME_ID: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/SimpleDownloadDialogFragment.kt#L96) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-t-i-t-l-e_-t-e-x-t.md b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-t-i-t-l-e_-t-e-x-t.md new file mode 100644 index 00000000000..38b5072a552 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/-k-e-y_-t-i-t-l-e_-t-e-x-t.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [SimpleDownloadDialogFragment](index.md) / [KEY_TITLE_TEXT](./-k-e-y_-t-i-t-l-e_-t-e-x-t.md) + +# KEY_TITLE_TEXT + +`const val KEY_TITLE_TEXT: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/SimpleDownloadDialogFragment.kt#L94) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/index.md b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/index.md new file mode 100644 index 00000000000..3c6281d1a85 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/index.md @@ -0,0 +1,52 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [SimpleDownloadDialogFragment](./index.md) + +# SimpleDownloadDialogFragment + +`class SimpleDownloadDialogFragment : `[`DownloadDialogFragment`](../-download-dialog-fragment/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/SimpleDownloadDialogFragment.kt#L26) + +A confirmation dialog to be called before a download is triggered. +Meant to be used in collaboration with [DownloadsFeature](../-downloads-feature/index.md) + +[SimpleDownloadDialogFragment](./index.md) is the default dialog use by DownloadsFeature if you don't provide a value. +It is composed by a title, a negative and a positive bottoms. When the positive button is clicked +the download it triggered. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SimpleDownloadDialogFragment()`
A confirmation dialog to be called before a download is triggered. Meant to be used in collaboration with [DownloadsFeature](../-downloads-feature/index.md) | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [onStartDownload](../-download-dialog-fragment/on-start-download.md) | `var onStartDownload: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
A callback to trigger a download, call it when you are ready to start a download. For instance, a valid use case can be in confirmation dialog, after the positive button is clicked, this callback must be called. | + +### Functions + +| Name | Summary | +|---|---| +| [onCreateDialog](on-create-dialog.md) | `fun onCreateDialog(savedInstanceState: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?): `[`Dialog`](https://developer.android.com/reference/android/app/Dialog.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [setDownload](../-download-dialog-fragment/set-download.md) | `fun setDownload(download: `[`Download`](../../mozilla.components.browser.session/-download/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
add the metadata of this download object to the arguments of this fragment. | + +### Companion Object Properties + +| Name | Summary | +|---|---| +| [KEY_CANCELABLE](-k-e-y_-c-a-n-c-e-l-a-b-l-e.md) | `const val KEY_CANCELABLE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [KEY_NEGATIVE_TEXT](-k-e-y_-n-e-g-a-t-i-v-e_-t-e-x-t.md) | `const val KEY_NEGATIVE_TEXT: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [KEY_POSITIVE_TEXT](-k-e-y_-p-o-s-i-t-i-v-e_-t-e-x-t.md) | `const val KEY_POSITIVE_TEXT: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [KEY_THEME_ID](-k-e-y_-t-h-e-m-e_-i-d.md) | `const val KEY_THEME_ID: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [KEY_TITLE_TEXT](-k-e-y_-t-i-t-l-e_-t-e-x-t.md) | `const val KEY_TITLE_TEXT: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [newInstance](new-instance.md) | `fun newInstance(dialogTitleText: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = mozac_feature_downloads_dialog_download, positiveButtonText: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = mozac_feature_downloads_dialog_download, negativeButtonText: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = mozac_feature_downloads_dialog_cancel, themeResId: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0, cancelable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false): `[`SimpleDownloadDialogFragment`](./index.md)
A builder method for creating a [SimpleDownloadDialogFragment](./index.md) | diff --git a/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/new-instance.md b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/new-instance.md new file mode 100644 index 00000000000..c27939a1f3b --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/new-instance.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [SimpleDownloadDialogFragment](index.md) / [newInstance](./new-instance.md) + +# newInstance + +`fun newInstance(@StringRes dialogTitleText: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = mozac_feature_downloads_dialog_download, @StringRes positiveButtonText: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = mozac_feature_downloads_dialog_download, @StringRes negativeButtonText: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = mozac_feature_downloads_dialog_cancel, @StyleRes themeResId: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0, cancelable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false): `[`SimpleDownloadDialogFragment`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/SimpleDownloadDialogFragment.kt#L63) + +A builder method for creating a [SimpleDownloadDialogFragment](index.md) + diff --git a/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/on-create-dialog.md b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/on-create-dialog.md new file mode 100644 index 00000000000..721c756404f --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/-simple-download-dialog-fragment/on-create-dialog.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.downloads](../index.md) / [SimpleDownloadDialogFragment](index.md) / [onCreateDialog](./on-create-dialog.md) + +# onCreateDialog + +`fun onCreateDialog(savedInstanceState: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?): `[`Dialog`](https://developer.android.com/reference/android/app/Dialog.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/downloads/src/main/java/mozilla/components/feature/downloads/SimpleDownloadDialogFragment.kt#L31) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.downloads/index.md b/docs/api/mozilla.components.feature.downloads/index.md new file mode 100644 index 00000000000..df5bcf73478 --- /dev/null +++ b/docs/api/mozilla.components.feature.downloads/index.md @@ -0,0 +1,20 @@ +[android-components](../index.md) / [mozilla.components.feature.downloads](./index.md) + +## Package mozilla.components.feature.downloads + +### Types + +| Name | Summary | +|---|---| +| [DownloadDialogFragment](-download-dialog-fragment/index.md) | `abstract class DownloadDialogFragment : DialogFragment`
This is a general representation of a dialog meant to be used in collaboration with [DownloadsFeature](-downloads-feature/index.md) to show a dialog before a download is triggered. If [SimpleDownloadDialogFragment](-simple-download-dialog-fragment/index.md) is not flexible enough for your use case you should inherit for this class. Be mindful to call [onStartDownload](-download-dialog-fragment/on-start-download.md) when you want to start the download. | +| [DownloadManager](-download-manager/index.md) | `class DownloadManager`
Handles the interactions with the [AndroidDownloadManager](-android-download-manager.md). | +| [DownloadsFeature](-downloads-feature/index.md) | `class DownloadsFeature : `[`SelectionAwareSessionObserver`](../mozilla.components.browser.session/-selection-aware-session-observer/index.md)`, `[`LifecycleAwareFeature`](../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)
Feature implementation to provide download functionality for the selected session. The feature will subscribe to the selected session and listen for downloads. | +| [SimpleDownloadDialogFragment](-simple-download-dialog-fragment/index.md) | `class SimpleDownloadDialogFragment : `[`DownloadDialogFragment`](-download-dialog-fragment/index.md)
A confirmation dialog to be called before a download is triggered. Meant to be used in collaboration with [DownloadsFeature](-downloads-feature/index.md) | + +### Type Aliases + +| Name | Summary | +|---|---| +| [AndroidDownloadManager](-android-download-manager.md) | `typealias AndroidDownloadManager = `[`DownloadManager`](https://developer.android.com/reference/android/app/DownloadManager.html) | +| [OnDownloadCompleted](-on-download-completed.md) | `typealias OnDownloadCompleted = (`[`Download`](../mozilla.components.browser.session/-download/index.md)`, `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [OnNeedToRequestPermissions](-on-need-to-request-permissions.md) | `typealias OnNeedToRequestPermissions = (permissions: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/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) | diff --git a/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/-init-.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/-init-.md new file mode 100644 index 00000000000..357b2c4340a --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage.view](../index.md) / [FindInPageBar](index.md) / [<init>](./-init-.md) + +# <init> + +`FindInPageBar(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)` + +A customizable "Find in page" bar implementing [FindInPageView](../-find-in-page-view/index.md). + diff --git a/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/clear.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/clear.md new file mode 100644 index 00000000000..07ea74738eb --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/clear.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage.view](../index.md) / [FindInPageBar](index.md) / [clear](./clear.md) + +# clear + +`fun clear(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageBar.kt#L74) + +Overrides [FindInPageView.clear](../-find-in-page-view/clear.md) + +Clears the UI state. + diff --git a/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/display-result.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/display-result.md new file mode 100644 index 00000000000..c04b8cab2c3 --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/display-result.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage.view](../index.md) / [FindInPageBar](index.md) / [displayResult](./display-result.md) + +# displayResult + +`fun displayResult(result: `[`FindResult`](../../mozilla.components.browser.session/-session/-find-result/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageBar.kt#L83) + +Overrides [FindInPageView.displayResult](../-find-in-page-view/display-result.md) + +Displays the given [Session.FindResult](../../mozilla.components.browser.session/-session/-find-result/index.md) state in the view. + diff --git a/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/focus.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/focus.md new file mode 100644 index 00000000000..6788478c174 --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/focus.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage.view](../index.md) / [FindInPageBar](index.md) / [focus](./focus.md) + +# focus + +`fun focus(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageBar.kt#L70) + +Overrides [FindInPageView.focus](../-find-in-page-view/focus.md) + +Requests focus for the input element the user can type their query into. + diff --git a/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/index.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/index.md new file mode 100644 index 00000000000..1376b248d76 --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/index.md @@ -0,0 +1,52 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage.view](../index.md) / [FindInPageBar](./index.md) + +# FindInPageBar + +`class FindInPageBar : ConstraintLayout, `[`FindInPageView`](../-find-in-page-view/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageBar.kt#L29) + +A customizable "Find in page" bar implementing [FindInPageView](../-find-in-page-view/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FindInPageBar(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = null, defStyleAttr: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)`
A customizable "Find in page" bar implementing [FindInPageView](../-find-in-page-view/index.md). | + +### Properties + +| Name | Summary | +|---|---| +| [listener](listener.md) | `var listener: `[`Listener`](../-find-in-page-view/-listener/index.md)`?`
Listener to be invoked after the user performs certain actions (e.g. "find next result"). | + +### Functions + +| Name | Summary | +|---|---| +| [clear](clear.md) | `fun clear(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Clears the UI state. | +| [displayResult](display-result.md) | `fun displayResult(result: `[`FindResult`](../../mozilla.components.browser.session/-session/-find-result/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Displays the given [Session.FindResult](../../mozilla.components.browser.session/-session/-find-result/index.md) state in the view. | +| [focus](focus.md) | `fun focus(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Requests focus for the input element the user can type their query into. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [asView](../-find-in-page-view/as-view.md) | `open fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html)
Casts this [FindInPageView](../-find-in-page-view/index.md) interface to an actual Android [View](https://developer.android.com/reference/android/view/View.html) object. | + +### Extension Properties + +| Name | Summary | +|---|---| +| [isLTR](../../mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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? | + +### Extension Functions + +| Name | Summary | +|---|---| +| [forEach](../../mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md) | `fun `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`.forEach(action: (`[`View`](https://developer.android.com/reference/android/view/View.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 the given action on each View in this ViewGroup. | +| [hideKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.hideKeyboard(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Hides the soft input window. | +| [isGone](../../mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [isVisible](../../mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [setPadding](../../mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.setPadding(padding: `[`Padding`](../../mozilla.components.support.base.android/-padding/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Set a padding using [Padding](../../mozilla.components.support.base.android/-padding/index.md) object. | +| [showKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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/mozilla.components.feature.findinpage.view/-find-in-page-bar/listener.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/listener.md new file mode 100644 index 00000000000..f919020492b --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-bar/listener.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage.view](../index.md) / [FindInPageBar](index.md) / [listener](./listener.md) + +# listener + +`var listener: `[`Listener`](../-find-in-page-view/-listener/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageBar.kt#L46) + +Overrides [FindInPageView.listener](../-find-in-page-view/listener.md) + +Listener to be invoked after the user performs certain actions (e.g. "find next result"). + diff --git a/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/index.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/index.md new file mode 100644 index 00000000000..bec30acf8de --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/index.md @@ -0,0 +1,15 @@ +[android-components](../../../index.md) / [mozilla.components.feature.findinpage.view](../../index.md) / [FindInPageView](../index.md) / [Listener](./index.md) + +# Listener + +`interface Listener` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageView.kt#L39) + +### Functions + +| Name | Summary | +|---|---| +| [onClearMatches](on-clear-matches.md) | `abstract fun onClearMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onClose](on-close.md) | `abstract fun onClose(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onFindAll](on-find-all.md) | `abstract fun onFindAll(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onNextResult](on-next-result.md) | `abstract fun onNextResult(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onPreviousResult](on-previous-result.md) | `abstract fun onPreviousResult(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-clear-matches.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-clear-matches.md new file mode 100644 index 00000000000..8df0cdfbd39 --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-clear-matches.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.feature.findinpage.view](../../index.md) / [FindInPageView](../index.md) / [Listener](index.md) / [onClearMatches](./on-clear-matches.md) + +# onClearMatches + +`abstract fun onClearMatches(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageView.kt#L44) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-close.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-close.md new file mode 100644 index 00000000000..7c8036d370d --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-close.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.feature.findinpage.view](../../index.md) / [FindInPageView](../index.md) / [Listener](index.md) / [onClose](./on-close.md) + +# onClose + +`abstract fun onClose(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageView.kt#L42) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-find-all.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-find-all.md new file mode 100644 index 00000000000..ce2fa76f024 --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-find-all.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.feature.findinpage.view](../../index.md) / [FindInPageView](../index.md) / [Listener](index.md) / [onFindAll](./on-find-all.md) + +# onFindAll + +`abstract fun onFindAll(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageView.kt#L43) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-next-result.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-next-result.md new file mode 100644 index 00000000000..d29db3aae91 --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-next-result.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.feature.findinpage.view](../../index.md) / [FindInPageView](../index.md) / [Listener](index.md) / [onNextResult](./on-next-result.md) + +# onNextResult + +`abstract fun onNextResult(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageView.kt#L41) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-previous-result.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-previous-result.md new file mode 100644 index 00000000000..49e7dacbf61 --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/-listener/on-previous-result.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.feature.findinpage.view](../../index.md) / [FindInPageView](../index.md) / [Listener](index.md) / [onPreviousResult](./on-previous-result.md) + +# onPreviousResult + +`abstract fun onPreviousResult(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageView.kt#L40) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/as-view.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/as-view.md new file mode 100644 index 00000000000..7b267d5c8be --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/as-view.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage.view](../index.md) / [FindInPageView](index.md) / [asView](./as-view.md) + +# asView + +`open fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageView.kt#L37) + +Casts this [FindInPageView](index.md) interface to an actual Android [View](https://developer.android.com/reference/android/view/View.html) object. + diff --git a/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/clear.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/clear.md new file mode 100644 index 00000000000..d3d0eae490c --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/clear.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage.view](../index.md) / [FindInPageView](index.md) / [clear](./clear.md) + +# clear + +`abstract fun clear(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageView.kt#L32) + +Clears the UI state. + diff --git a/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/display-result.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/display-result.md new file mode 100644 index 00000000000..903a81257c1 --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/display-result.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage.view](../index.md) / [FindInPageView](index.md) / [displayResult](./display-result.md) + +# displayResult + +`abstract fun displayResult(result: `[`FindResult`](../../mozilla.components.browser.session/-session/-find-result/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageView.kt#L22) + +Displays the given [Session.FindResult](../../mozilla.components.browser.session/-session/-find-result/index.md) state in the view. + diff --git a/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/focus.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/focus.md new file mode 100644 index 00000000000..e329b01cc53 --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/focus.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage.view](../index.md) / [FindInPageView](index.md) / [focus](./focus.md) + +# focus + +`abstract fun focus(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageView.kt#L27) + +Requests focus for the input element the user can type their query into. + diff --git a/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/index.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/index.md new file mode 100644 index 00000000000..72b3eafe833 --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/index.md @@ -0,0 +1,34 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage.view](../index.md) / [FindInPageView](./index.md) + +# FindInPageView + +`interface FindInPageView` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageView.kt#L13) + +An interface for views that can display "find in page" results and related UI controls. + +### Types + +| Name | Summary | +|---|---| +| [Listener](-listener/index.md) | `interface Listener` | + +### Properties + +| Name | Summary | +|---|---| +| [listener](listener.md) | `abstract var listener: `[`Listener`](-listener/index.md)`?`
Listener to be invoked after the user performs certain actions (e.g. "find next result"). | + +### Functions + +| Name | Summary | +|---|---| +| [asView](as-view.md) | `open fun asView(): `[`View`](https://developer.android.com/reference/android/view/View.html)
Casts this [FindInPageView](./index.md) interface to an actual Android [View](https://developer.android.com/reference/android/view/View.html) object. | +| [clear](clear.md) | `abstract fun clear(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Clears the UI state. | +| [displayResult](display-result.md) | `abstract fun displayResult(result: `[`FindResult`](../../mozilla.components.browser.session/-session/-find-result/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Displays the given [Session.FindResult](../../mozilla.components.browser.session/-session/-find-result/index.md) state in the view. | +| [focus](focus.md) | `abstract fun focus(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Requests focus for the input element the user can type their query into. | + +### Inheritors + +| Name | Summary | +|---|---| +| [FindInPageBar](../-find-in-page-bar/index.md) | `class FindInPageBar : ConstraintLayout, `[`FindInPageView`](./index.md)
A customizable "Find in page" bar implementing [FindInPageView](./index.md). | diff --git a/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/listener.md b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/listener.md new file mode 100644 index 00000000000..84608f0280b --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/-find-in-page-view/listener.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage.view](../index.md) / [FindInPageView](index.md) / [listener](./listener.md) + +# listener + +`abstract var listener: `[`Listener`](-listener/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/view/FindInPageView.kt#L17) + +Listener to be invoked after the user performs certain actions (e.g. "find next result"). + diff --git a/docs/api/mozilla.components.feature.findinpage.view/index.md b/docs/api/mozilla.components.feature.findinpage.view/index.md new file mode 100644 index 00000000000..209a23217a0 --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage.view/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.feature.findinpage.view](./index.md) + +## Package mozilla.components.feature.findinpage.view + +### Types + +| Name | Summary | +|---|---| +| [FindInPageBar](-find-in-page-bar/index.md) | `class FindInPageBar : ConstraintLayout, `[`FindInPageView`](-find-in-page-view/index.md)
A customizable "Find in page" bar implementing [FindInPageView](-find-in-page-view/index.md). | +| [FindInPageView](-find-in-page-view/index.md) | `interface FindInPageView`
An interface for views that can display "find in page" results and related UI controls. | diff --git a/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/-init-.md b/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/-init-.md new file mode 100644 index 00000000000..fe4c87be0a6 --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage](../index.md) / [FindInPageFeature](index.md) / [<init>](./-init-.md) + +# <init> + +`FindInPageFeature(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, view: `[`FindInPageView`](../../mozilla.components.feature.findinpage.view/-find-in-page-view/index.md)`, onClose: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null)` + +Feature implementation that will keep a [FindInPageView](../../mozilla.components.feature.findinpage.view/-find-in-page-view/index.md) in sync with a bound [Session](../../mozilla.components.browser.session/-session/index.md). + diff --git a/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/bind.md b/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/bind.md new file mode 100644 index 00000000000..0e17493f35c --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/bind.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage](../index.md) / [FindInPageFeature](index.md) / [bind](./bind.md) + +# bind + +`fun bind(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/FindInPageFeature.kt#L43) + +Binds this feature to the given [Session](../../mozilla.components.browser.session/-session/index.md). Until unbound the [FindInPageView](../../mozilla.components.feature.findinpage.view/-find-in-page-view/index.md) will be updated presenting the +current "Find in Page" state. + diff --git a/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/index.md b/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/index.md new file mode 100644 index 00000000000..3132c35482b --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage](../index.md) / [FindInPageFeature](./index.md) + +# FindInPageFeature + +`class FindInPageFeature : `[`LifecycleAwareFeature`](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)`, `[`BackHandler`](../../mozilla.components.support.base.feature/-back-handler/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/FindInPageFeature.kt#L19) + +Feature implementation that will keep a [FindInPageView](../../mozilla.components.feature.findinpage.view/-find-in-page-view/index.md) in sync with a bound [Session](../../mozilla.components.browser.session/-session/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FindInPageFeature(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, view: `[`FindInPageView`](../../mozilla.components.feature.findinpage.view/-find-in-page-view/index.md)`, onClose: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null)`
Feature implementation that will keep a [FindInPageView](../../mozilla.components.feature.findinpage.view/-find-in-page-view/index.md) in sync with a bound [Session](../../mozilla.components.browser.session/-session/index.md). | + +### Functions + +| Name | Summary | +|---|---| +| [bind](bind.md) | `fun bind(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Binds this feature to the given [Session](../../mozilla.components.browser.session/-session/index.md). Until unbound the [FindInPageView](../../mozilla.components.feature.findinpage.view/-find-in-page-view/index.md) will be updated presenting the current "Find in Page" state. | +| [onBackPressed](on-back-pressed.md) | `fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true if the back button press was handled and the feature unbound from a session. | +| [start](start.md) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [stop](stop.md) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [unbind](unbind.md) | `fun unbind(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Unbinds the feature from a previously bound [Session](../../mozilla.components.browser.session/-session/index.md). The [FindInPageView](../../mozilla.components.feature.findinpage.view/-find-in-page-view/index.md) will be cleared and not be updated to present the "Find in Page" state anymore. | diff --git a/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/on-back-pressed.md b/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/on-back-pressed.md new file mode 100644 index 00000000000..6eb7a28d45d --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/on-back-pressed.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage](../index.md) / [FindInPageFeature](index.md) / [onBackPressed](./on-back-pressed.md) + +# onBackPressed + +`fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/FindInPageFeature.kt#L53) + +Overrides [BackHandler.onBackPressed](../../mozilla.components.support.base.feature/-back-handler/on-back-pressed.md) + +Returns true if the back button press was handled and the feature unbound from a session. + diff --git a/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/start.md b/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/start.md new file mode 100644 index 00000000000..3fecd45b8b9 --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/start.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage](../index.md) / [FindInPageFeature](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/FindInPageFeature.kt#L29) + +Overrides [LifecycleAwareFeature.start](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/start.md) + diff --git a/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/stop.md b/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/stop.md new file mode 100644 index 00000000000..38184547092 --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/stop.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage](../index.md) / [FindInPageFeature](index.md) / [stop](./stop.md) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/FindInPageFeature.kt#L34) + +Overrides [LifecycleAwareFeature.stop](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/stop.md) + diff --git a/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/unbind.md b/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/unbind.md new file mode 100644 index 00000000000..d9b870789aa --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage/-find-in-page-feature/unbind.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.feature.findinpage](../index.md) / [FindInPageFeature](index.md) / [unbind](./unbind.md) + +# unbind + +`fun unbind(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/findinpage/src/main/java/mozilla/components/feature/findinpage/FindInPageFeature.kt#L66) + +Unbinds the feature from a previously bound [Session](../../mozilla.components.browser.session/-session/index.md). The [FindInPageView](../../mozilla.components.feature.findinpage.view/-find-in-page-view/index.md) will be cleared and not be updated +to present the "Find in Page" state anymore. + diff --git a/docs/api/mozilla.components.feature.findinpage/index.md b/docs/api/mozilla.components.feature.findinpage/index.md new file mode 100644 index 00000000000..110e367f84f --- /dev/null +++ b/docs/api/mozilla.components.feature.findinpage/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.feature.findinpage](./index.md) + +## Package mozilla.components.feature.findinpage + +### Types + +| Name | Summary | +|---|---| +| [FindInPageFeature](-find-in-page-feature/index.md) | `class FindInPageFeature : `[`LifecycleAwareFeature`](../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)`, `[`BackHandler`](../mozilla.components.support.base.feature/-back-handler/index.md)
Feature implementation that will keep a [FindInPageView](../mozilla.components.feature.findinpage.view/-find-in-page-view/index.md) in sync with a bound [Session](../mozilla.components.browser.session/-session/index.md). | diff --git a/docs/api/mozilla.components.feature.intent/-intent-handler.md b/docs/api/mozilla.components.feature.intent/-intent-handler.md new file mode 100644 index 00000000000..151b6f669ab --- /dev/null +++ b/docs/api/mozilla.components.feature.intent/-intent-handler.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.feature.intent](index.md) / [IntentHandler](./-intent-handler.md) + +# IntentHandler + +`typealias IntentHandler = (`[`Intent`](https://developer.android.com/reference/android/content/Intent.html)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/intent/src/main/java/mozilla/components/feature/intent/IntentProcessor.kt#L19) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.intent/-intent-processor/-a-c-t-i-v-e_-s-e-s-s-i-o-n_-i-d.md b/docs/api/mozilla.components.feature.intent/-intent-processor/-a-c-t-i-v-e_-s-e-s-s-i-o-n_-i-d.md new file mode 100644 index 00000000000..d6cdef0c9e1 --- /dev/null +++ b/docs/api/mozilla.components.feature.intent/-intent-processor/-a-c-t-i-v-e_-s-e-s-s-i-o-n_-i-d.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.intent](../index.md) / [IntentProcessor](index.md) / [ACTIVE_SESSION_ID](./-a-c-t-i-v-e_-s-e-s-s-i-o-n_-i-d.md) + +# ACTIVE_SESSION_ID + +`const val ACTIVE_SESSION_ID: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/intent/src/main/java/mozilla/components/feature/intent/IntentProcessor.kt#L135) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.intent/-intent-processor/-init-.md b/docs/api/mozilla.components.feature.intent/-intent-processor/-init-.md new file mode 100644 index 00000000000..cc4f9b7ed8b --- /dev/null +++ b/docs/api/mozilla.components.feature.intent/-intent-processor/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.intent](../index.md) / [IntentProcessor](index.md) / [<init>](./-init-.md) + +# <init> + +`IntentProcessor(sessionUseCases: `[`SessionUseCases`](../../mozilla.components.feature.session/-session-use-cases/index.md)`, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, searchUseCases: `[`SearchUseCases`](../../mozilla.components.feature.search/-search-use-cases/index.md)`, context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, 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. + diff --git a/docs/api/mozilla.components.feature.intent/-intent-processor/index.md b/docs/api/mozilla.components.feature.intent/-intent-processor/index.md new file mode 100644 index 00000000000..15ef3702f6e --- /dev/null +++ b/docs/api/mozilla.components.feature.intent/-intent-processor/index.md @@ -0,0 +1,27 @@ +[android-components](../../index.md) / [mozilla.components.feature.intent](../index.md) / [IntentProcessor](./index.md) + +# IntentProcessor + +`class IntentProcessor` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/intent/src/main/java/mozilla/components/feature/intent/IntentProcessor.kt#L32) + +Processor for intents which should trigger session-related actions. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `IntentProcessor(sessionUseCases: `[`SessionUseCases`](../../mozilla.components.feature.session/-session-use-cases/index.md)`, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, searchUseCases: `[`SearchUseCases`](../../mozilla.components.feature.search/-search-use-cases/index.md)`, context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, 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 + +| Name | Summary | +|---|---| +| [process](process.md) | `fun process(intent: `[`Intent`](https://developer.android.com/reference/android/content/Intent.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Processes the given intent by invoking the registered handler. | +| [registerHandler](register-handler.md) | `fun registerHandler(action: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, handler: `[`IntentHandler`](../-intent-handler.md)`): `[`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.md) | `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 + +| Name | Summary | +|---|---| +| [ACTIVE_SESSION_ID](-a-c-t-i-v-e_-s-e-s-s-i-o-n_-i-d.md) | `const val ACTIVE_SESSION_ID: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.feature.intent/-intent-processor/process.md b/docs/api/mozilla.components.feature.intent/-intent-processor/process.md new file mode 100644 index 00000000000..69fa9427a4f --- /dev/null +++ b/docs/api/mozilla.components.feature.intent/-intent-processor/process.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.feature.intent](../index.md) / [IntentProcessor](index.md) / [process](./process.md) + +# process + +`fun process(intent: `[`Intent`](https://developer.android.com/reference/android/content/Intent.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/intent/src/main/java/mozilla/components/feature/intent/IntentProcessor.kt#L110) + +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/mozilla.components.feature.intent/-intent-processor/register-handler.md b/docs/api/mozilla.components.feature.intent/-intent-processor/register-handler.md new file mode 100644 index 00000000000..27e50be357d --- /dev/null +++ b/docs/api/mozilla.components.feature.intent/-intent-processor/register-handler.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.feature.intent](../index.md) / [IntentProcessor](index.md) / [registerHandler](./register-handler.md) + +# registerHandler + +`fun registerHandler(action: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, handler: `[`IntentHandler`](../-intent-handler.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/intent/src/main/java/mozilla/components/feature/intent/IntentProcessor.kt#L121) + +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/mozilla.components.feature.intent/-intent-processor/unregister-handler.md b/docs/api/mozilla.components.feature.intent/-intent-processor/unregister-handler.md new file mode 100644 index 00000000000..f03aa6c728b --- /dev/null +++ b/docs/api/mozilla.components.feature.intent/-intent-processor/unregister-handler.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.feature.intent](../index.md) / [IntentProcessor](index.md) / [unregisterHandler](./unregister-handler.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/intent/src/main/java/mozilla/components/feature/intent/IntentProcessor.kt#L130) + +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/mozilla.components.feature.intent/index.md b/docs/api/mozilla.components.feature.intent/index.md new file mode 100644 index 00000000000..f01a95af5d6 --- /dev/null +++ b/docs/api/mozilla.components.feature.intent/index.md @@ -0,0 +1,15 @@ +[android-components](../index.md) / [mozilla.components.feature.intent](./index.md) + +## Package mozilla.components.feature.intent + +### Types + +| Name | Summary | +|---|---| +| [IntentProcessor](-intent-processor/index.md) | `class IntentProcessor`
Processor for intents which should trigger session-related actions. | + +### Type Aliases + +| Name | Summary | +|---|---| +| [IntentHandler](-intent-handler.md) | `typealias IntentHandler = (`[`Intent`](https://developer.android.com/reference/android/content/Intent.html)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | diff --git a/docs/api/mozilla.components.feature.prompts/-on-need-to-request-permissions.md b/docs/api/mozilla.components.feature.prompts/-on-need-to-request-permissions.md new file mode 100644 index 00000000000..230aa1cf8fc --- /dev/null +++ b/docs/api/mozilla.components.feature.prompts/-on-need-to-request-permissions.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.feature.prompts](index.md) / [OnNeedToRequestPermissions](./-on-need-to-request-permissions.md) + +# OnNeedToRequestPermissions + +`typealias OnNeedToRequestPermissions = (permissions: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/prompts/src/main/java/mozilla/components/feature/prompts/PromptFeature.kt#L43) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.prompts/-prompt-feature/-f-i-l-e_-p-i-c-k-e-r_-a-c-t-i-v-i-t-y_-r-e-q-u-e-s-t_-c-o-d-e.md b/docs/api/mozilla.components.feature.prompts/-prompt-feature/-f-i-l-e_-p-i-c-k-e-r_-a-c-t-i-v-i-t-y_-r-e-q-u-e-s-t_-c-o-d-e.md new file mode 100644 index 00000000000..918e7b5a07f --- /dev/null +++ b/docs/api/mozilla.components.feature.prompts/-prompt-feature/-f-i-l-e_-p-i-c-k-e-r_-a-c-t-i-v-i-t-y_-r-e-q-u-e-s-t_-c-o-d-e.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.prompts](../index.md) / [PromptFeature](index.md) / [FILE_PICKER_ACTIVITY_REQUEST_CODE](./-f-i-l-e_-p-i-c-k-e-r_-a-c-t-i-v-i-t-y_-r-e-q-u-e-s-t_-c-o-d-e.md) + +# FILE_PICKER_ACTIVITY_REQUEST_CODE + +`const val FILE_PICKER_ACTIVITY_REQUEST_CODE: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/prompts/src/main/java/mozilla/components/feature/prompts/PromptFeature.kt#L520) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.prompts/-prompt-feature/-init-.md b/docs/api/mozilla.components.feature.prompts/-prompt-feature/-init-.md new file mode 100644 index 00000000000..e6d9c228b24 --- /dev/null +++ b/docs/api/mozilla.components.feature.prompts/-prompt-feature/-init-.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.feature.prompts](../index.md) / [PromptFeature](index.md) / [<init>](./-init-.md) + +# <init> + +`PromptFeature(activity: `[`Activity`](https://developer.android.com/reference/android/app/Activity.html)`? = null, fragment: Fragment? = null, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, fragmentManager: FragmentManager, onNeedToRequestPermissions: `[`OnNeedToRequestPermissions`](../-on-need-to-request-permissions.md)`)` + +Feature for displaying native dialogs for html elements like: input type +date, file, time, color, option, menu, authentication, confirmation and alerts. + +There are some requests that are handled with intents instead of dialogs, +like file choosers and others. For this reason, you have to keep the feature +aware of the flow of requesting data from other apps, overriding +onActivityResult in your [Activity](https://developer.android.com/reference/android/app/Activity.html) or [Fragment](#) and forward its calls +to [onActivityResult](on-activity-result.md). + +This feature will subscribe to the currently selected [Session](../../mozilla.components.browser.session/-session/index.md) and display +a suitable native dialog based on [Session.Observer.onPromptRequested](../../mozilla.components.browser.session/-session/-observer/on-prompt-requested.md) events. +Once the dialog is closed or the user selects an item from the dialog +the related [PromptRequest](../../mozilla.components.concept.engine.prompt/-prompt-request/index.md) will be consumed. + diff --git a/docs/api/mozilla.components.feature.prompts/-prompt-feature/index.md b/docs/api/mozilla.components.feature.prompts/-prompt-feature/index.md new file mode 100644 index 00000000000..a757db4d8b2 --- /dev/null +++ b/docs/api/mozilla.components.feature.prompts/-prompt-feature/index.md @@ -0,0 +1,40 @@ +[android-components](../../index.md) / [mozilla.components.feature.prompts](../index.md) / [PromptFeature](./index.md) + +# PromptFeature + +`class PromptFeature : `[`LifecycleAwareFeature`](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/prompts/src/main/java/mozilla/components/feature/prompts/PromptFeature.kt#L78) + +Feature for displaying native dialogs for html elements like: input type +date, file, time, color, option, menu, authentication, confirmation and alerts. + +There are some requests that are handled with intents instead of dialogs, +like file choosers and others. For this reason, you have to keep the feature +aware of the flow of requesting data from other apps, overriding +onActivityResult in your [Activity](https://developer.android.com/reference/android/app/Activity.html) or [Fragment](#) and forward its calls +to [onActivityResult](on-activity-result.md). + +This feature will subscribe to the currently selected [Session](../../mozilla.components.browser.session/-session/index.md) and display +a suitable native dialog based on [Session.Observer.onPromptRequested](../../mozilla.components.browser.session/-session/-observer/on-prompt-requested.md) events. +Once the dialog is closed or the user selects an item from the dialog +the related [PromptRequest](../../mozilla.components.concept.engine.prompt/-prompt-request/index.md) will be consumed. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `PromptFeature(activity: `[`Activity`](https://developer.android.com/reference/android/app/Activity.html)`? = null, fragment: Fragment? = null, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, fragmentManager: FragmentManager, onNeedToRequestPermissions: `[`OnNeedToRequestPermissions`](../-on-need-to-request-permissions.md)`)`
Feature for displaying native dialogs for html elements like: input type date, file, time, color, option, menu, authentication, confirmation and alerts. | + +### Functions + +| Name | Summary | +|---|---| +| [onActivityResult](on-activity-result.md) | `fun onActivityResult(requestCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, resultCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, intent: `[`Intent`](https://developer.android.com/reference/android/content/Intent.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Notifies the feature of intent results for prompt requests handled by other apps like file chooser requests. | +| [onPermissionsResult](on-permissions-result.md) | `fun onPermissionsResult(permissions: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>, grantResults: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Notifies the feature that the permissions request was completed. It will then either process or dismiss the prompt request. | +| [start](start.md) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts observing the selected session to listen for prompt requests and displays a dialog when needed. | +| [stop](stop.md) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stops observing the selected session for incoming prompt requests. | + +### Companion Object Properties + +| Name | Summary | +|---|---| +| [FILE_PICKER_ACTIVITY_REQUEST_CODE](-f-i-l-e_-p-i-c-k-e-r_-a-c-t-i-v-i-t-y_-r-e-q-u-e-s-t_-c-o-d-e.md) | `const val FILE_PICKER_ACTIVITY_REQUEST_CODE: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.feature.prompts/-prompt-feature/on-activity-result.md b/docs/api/mozilla.components.feature.prompts/-prompt-feature/on-activity-result.md new file mode 100644 index 00000000000..40e7b6fa0bf --- /dev/null +++ b/docs/api/mozilla.components.feature.prompts/-prompt-feature/on-activity-result.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.feature.prompts](../index.md) / [PromptFeature](index.md) / [onActivityResult](./on-activity-result.md) + +# onActivityResult + +`fun onActivityResult(requestCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, resultCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, intent: `[`Intent`](https://developer.android.com/reference/android/content/Intent.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/prompts/src/main/java/mozilla/components/feature/prompts/PromptFeature.kt#L129) + +Notifies the feature of intent results for prompt requests handled by +other apps like file chooser requests. + +### Parameters + +`requestCode` - The code of the app that requested the intent. + +`intent` - The result of the request. \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.prompts/-prompt-feature/on-permissions-result.md b/docs/api/mozilla.components.feature.prompts/-prompt-feature/on-permissions-result.md new file mode 100644 index 00000000000..45f35ba7bf4 --- /dev/null +++ b/docs/api/mozilla.components.feature.prompts/-prompt-feature/on-permissions-result.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.feature.prompts](../index.md) / [PromptFeature](index.md) / [onPermissionsResult](./on-permissions-result.md) + +# onPermissionsResult + +`fun onPermissionsResult(permissions: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>, grantResults: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/prompts/src/main/java/mozilla/components/feature/prompts/PromptFeature.kt#L153) + +Notifies the feature that the permissions request was completed. It will then +either process or dismiss the prompt request. + +### Parameters + +`permissions` - List of permission requested. + +`grantResults` - The grant results for the corresponding permissions + +**See Also** + +[onNeedToRequestPermissions](#) + diff --git a/docs/api/mozilla.components.feature.prompts/-prompt-feature/start.md b/docs/api/mozilla.components.feature.prompts/-prompt-feature/start.md new file mode 100644 index 00000000000..31b859377e0 --- /dev/null +++ b/docs/api/mozilla.components.feature.prompts/-prompt-feature/start.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.feature.prompts](../index.md) / [PromptFeature](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/prompts/src/main/java/mozilla/components/feature/prompts/PromptFeature.kt#L104) + +Overrides [LifecycleAwareFeature.start](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/start.md) + +Starts observing the selected session to listen for prompt requests +and displays a dialog when needed. + diff --git a/docs/api/mozilla.components.feature.prompts/-prompt-feature/stop.md b/docs/api/mozilla.components.feature.prompts/-prompt-feature/stop.md new file mode 100644 index 00000000000..e73b765d4a3 --- /dev/null +++ b/docs/api/mozilla.components.feature.prompts/-prompt-feature/stop.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.prompts](../index.md) / [PromptFeature](index.md) / [stop](./stop.md) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/prompts/src/main/java/mozilla/components/feature/prompts/PromptFeature.kt#L118) + +Overrides [LifecycleAwareFeature.stop](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/stop.md) + +Stops observing the selected session for incoming prompt requests. + diff --git a/docs/api/mozilla.components.feature.prompts/index.md b/docs/api/mozilla.components.feature.prompts/index.md new file mode 100644 index 00000000000..8cd18404099 --- /dev/null +++ b/docs/api/mozilla.components.feature.prompts/index.md @@ -0,0 +1,15 @@ +[android-components](../index.md) / [mozilla.components.feature.prompts](./index.md) + +## Package mozilla.components.feature.prompts + +### Types + +| Name | Summary | +|---|---| +| [PromptFeature](-prompt-feature/index.md) | `class PromptFeature : `[`LifecycleAwareFeature`](../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)
Feature for displaying native dialogs for html elements like: input type date, file, time, color, option, menu, authentication, confirmation and alerts. | + +### Type Aliases + +| Name | Summary | +|---|---| +| [OnNeedToRequestPermissions](-on-need-to-request-permissions.md) | `typealias OnNeedToRequestPermissions = (permissions: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/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) | diff --git a/docs/api/mozilla.components.feature.search/-search-use-cases/-default-search-use-case/-init-.md b/docs/api/mozilla.components.feature.search/-search-use-cases/-default-search-use-case/-init-.md new file mode 100644 index 00000000000..ea6112f79c5 --- /dev/null +++ b/docs/api/mozilla.components.feature.search/-search-use-cases/-default-search-use-case/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.feature.search](../../index.md) / [SearchUseCases](../index.md) / [DefaultSearchUseCase](index.md) / [<init>](./-init-.md) + +# <init> + +`DefaultSearchUseCase(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, searchEngineManager: `[`SearchEngineManager`](../../../mozilla.components.browser.search/-search-engine-manager/index.md)`, sessionManager: `[`SessionManager`](../../../mozilla.components.browser.session/-session-manager/index.md)`, onNoSession: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`)` \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.search/-search-use-cases/-default-search-use-case/index.md b/docs/api/mozilla.components.feature.search/-search-use-cases/-default-search-use-case/index.md new file mode 100644 index 00000000000..f8cbbed23af --- /dev/null +++ b/docs/api/mozilla.components.feature.search/-search-use-cases/-default-search-use-case/index.md @@ -0,0 +1,17 @@ +[android-components](../../../index.md) / [mozilla.components.feature.search](../../index.md) / [SearchUseCases](../index.md) / [DefaultSearchUseCase](./index.md) + +# DefaultSearchUseCase + +`class DefaultSearchUseCase : `[`SearchUseCase`](../-search-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/search/src/main/java/mozilla/components/feature/search/SearchUseCases.kt#L31) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `DefaultSearchUseCase(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, searchEngineManager: `[`SearchEngineManager`](../../../mozilla.components.browser.search/-search-engine-manager/index.md)`, sessionManager: `[`SessionManager`](../../../mozilla.components.browser.session/-session-manager/index.md)`, onNoSession: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `fun invoke(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)
Triggers a search in the currently selected session.`fun invoke(searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`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/mozilla.components.feature.search/-search-use-cases/-default-search-use-case/invoke.md b/docs/api/mozilla.components.feature.search/-search-use-cases/-default-search-use-case/invoke.md new file mode 100644 index 00000000000..bfd323c9acb --- /dev/null +++ b/docs/api/mozilla.components.feature.search/-search-use-cases/-default-search-use-case/invoke.md @@ -0,0 +1,20 @@ +[android-components](../../../index.md) / [mozilla.components.feature.search](../../index.md) / [SearchUseCases](../index.md) / [DefaultSearchUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`fun invoke(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/search/src/main/java/mozilla/components/feature/search/SearchUseCases.kt#L40) + +Overrides [SearchUseCase.invoke](../-search-use-case/invoke.md) + +Triggers a search in the currently selected session. + +`fun invoke(searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/search/src/main/java/mozilla/components/feature/search/SearchUseCases.kt#L51) + +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/mozilla.components.feature.search/-search-use-cases/-init-.md b/docs/api/mozilla.components.feature.search/-search-use-cases/-init-.md new file mode 100644 index 00000000000..dace1a5d5e1 --- /dev/null +++ b/docs/api/mozilla.components.feature.search/-search-use-cases/-init-.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.feature.search](../index.md) / [SearchUseCases](index.md) / [<init>](./-init-.md) + +# <init> + +`SearchUseCases(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, searchEngineManager: `[`SearchEngineManager`](../../mozilla.components.browser.search/-search-engine-manager/index.md)`, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, onNoSession: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Session`](../../mozilla.components.browser.session/-session/index.md)` = { url -> + Session(url).apply { sessionManager.add(this) } + })` + +Contains use cases related to the search feature. + +### Parameters + +`onNoSession` - When invoking a use case that requires a (selected) [Session](../../mozilla.components.browser.session/-session/index.md) and when no [Session](../../mozilla.components.browser.session/-session/index.md) is available +this (optional) lambda will be invoked to create a [Session](../../mozilla.components.browser.session/-session/index.md). The default implementation creates a [Session](../../mozilla.components.browser.session/-session/index.md) and adds +it to the [SessionManager](../../mozilla.components.browser.session/-session-manager/index.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.search/-search-use-cases/-new-tab-search-use-case/-init-.md b/docs/api/mozilla.components.feature.search/-search-use-cases/-new-tab-search-use-case/-init-.md new file mode 100644 index 00000000000..834dc4b53bd --- /dev/null +++ b/docs/api/mozilla.components.feature.search/-search-use-cases/-new-tab-search-use-case/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.feature.search](../../index.md) / [SearchUseCases](../index.md) / [NewTabSearchUseCase](index.md) / [<init>](./-init-.md) + +# <init> + +`NewTabSearchUseCase(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, searchEngineManager: `[`SearchEngineManager`](../../../mozilla.components.browser.search/-search-engine-manager/index.md)`, sessionManager: `[`SessionManager`](../../../mozilla.components.browser.session/-session-manager/index.md)`)` \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.search/-search-use-cases/-new-tab-search-use-case/index.md b/docs/api/mozilla.components.feature.search/-search-use-cases/-new-tab-search-use-case/index.md new file mode 100644 index 00000000000..81632fa9c20 --- /dev/null +++ b/docs/api/mozilla.components.feature.search/-search-use-cases/-new-tab-search-use-case/index.md @@ -0,0 +1,17 @@ +[android-components](../../../index.md) / [mozilla.components.feature.search](../../index.md) / [SearchUseCases](../index.md) / [NewTabSearchUseCase](./index.md) + +# NewTabSearchUseCase + +`class NewTabSearchUseCase : `[`SearchUseCase`](../-search-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/search/src/main/java/mozilla/components/feature/search/SearchUseCases.kt#L62) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `NewTabSearchUseCase(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, searchEngineManager: `[`SearchEngineManager`](../../../mozilla.components.browser.search/-search-engine-manager/index.md)`, sessionManager: `[`SessionManager`](../../../mozilla.components.browser.session/-session-manager/index.md)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `fun invoke(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)`fun invoke(searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, source: `[`Source`](../../../mozilla.components.browser.session/-session/-source/index.md)`, selected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, private: `[`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)
Triggers a search on a new session, using the default search engine for the provided search terms. | diff --git a/docs/api/mozilla.components.feature.search/-search-use-cases/-new-tab-search-use-case/invoke.md b/docs/api/mozilla.components.feature.search/-search-use-cases/-new-tab-search-use-case/invoke.md new file mode 100644 index 00000000000..c35df17fc59 --- /dev/null +++ b/docs/api/mozilla.components.feature.search/-search-use-cases/-new-tab-search-use-case/invoke.md @@ -0,0 +1,21 @@ +[android-components](../../../index.md) / [mozilla.components.feature.search](../../index.md) / [SearchUseCases](../index.md) / [NewTabSearchUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`fun invoke(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/search/src/main/java/mozilla/components/feature/search/SearchUseCases.kt#L67) + +Overrides [SearchUseCase.invoke](../-search-use-case/invoke.md) + +`fun invoke(searchTerms: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, source: `[`Source`](../../../mozilla.components.browser.session/-session/-source/index.md)`, selected: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, private: `[`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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/search/src/main/java/mozilla/components/feature/search/SearchUseCases.kt#L79) + +Triggers a search on a new session, using the default search engine for the provided search terms. + +### Parameters + +`searchTerms` - the search terms. + +`selected` - whether or not the new session should be selected, defaults to true. + +`private` - whether or not the new session should be private, defaults to false. + +`source` - the source of the new session. \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.search/-search-use-cases/-search-use-case/index.md b/docs/api/mozilla.components.feature.search/-search-use-cases/-search-use-case/index.md new file mode 100644 index 00000000000..323126fdc34 --- /dev/null +++ b/docs/api/mozilla.components.feature.search/-search-use-cases/-search-use-case/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.feature.search](../../index.md) / [SearchUseCases](../index.md) / [SearchUseCase](./index.md) + +# SearchUseCase + +`interface SearchUseCase` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/search/src/main/java/mozilla/components/feature/search/SearchUseCases.kt#L27) + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `abstract fun invoke(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) | + +### Inheritors + +| Name | Summary | +|---|---| +| [DefaultSearchUseCase](../-default-search-use-case/index.md) | `class DefaultSearchUseCase : `[`SearchUseCase`](./index.md) | +| [NewTabSearchUseCase](../-new-tab-search-use-case/index.md) | `class NewTabSearchUseCase : `[`SearchUseCase`](./index.md) | diff --git a/docs/api/mozilla.components.feature.search/-search-use-cases/-search-use-case/invoke.md b/docs/api/mozilla.components.feature.search/-search-use-cases/-search-use-case/invoke.md new file mode 100644 index 00000000000..15b39afde16 --- /dev/null +++ b/docs/api/mozilla.components.feature.search/-search-use-cases/-search-use-case/invoke.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.feature.search](../../index.md) / [SearchUseCases](../index.md) / [SearchUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`abstract fun invoke(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/search/src/main/java/mozilla/components/feature/search/SearchUseCases.kt#L28) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.search/-search-use-cases/default-search.md b/docs/api/mozilla.components.feature.search/-search-use-cases/default-search.md new file mode 100644 index 00000000000..fb906d9ff21 --- /dev/null +++ b/docs/api/mozilla.components.feature.search/-search-use-cases/default-search.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.search](../index.md) / [SearchUseCases](index.md) / [defaultSearch](./default-search.md) + +# defaultSearch + +`val defaultSearch: `[`DefaultSearchUseCase`](-default-search-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/search/src/main/java/mozilla/components/feature/search/SearchUseCases.kt#L95) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.search/-search-use-cases/index.md b/docs/api/mozilla.components.feature.search/-search-use-cases/index.md new file mode 100644 index 00000000000..ea1a065869d --- /dev/null +++ b/docs/api/mozilla.components.feature.search/-search-use-cases/index.md @@ -0,0 +1,36 @@ +[android-components](../../index.md) / [mozilla.components.feature.search](../index.md) / [SearchUseCases](./index.md) + +# SearchUseCases + +`class SearchUseCases` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/search/src/main/java/mozilla/components/feature/search/SearchUseCases.kt#L19) + +Contains use cases related to the search feature. + +### Parameters + +`onNoSession` - When invoking a use case that requires a (selected) [Session](../../mozilla.components.browser.session/-session/index.md) and when no [Session](../../mozilla.components.browser.session/-session/index.md) is available +this (optional) lambda will be invoked to create a [Session](../../mozilla.components.browser.session/-session/index.md). The default implementation creates a [Session](../../mozilla.components.browser.session/-session/index.md) and adds +it to the [SessionManager](../../mozilla.components.browser.session/-session-manager/index.md). + +### Types + +| Name | Summary | +|---|---| +| [DefaultSearchUseCase](-default-search-use-case/index.md) | `class DefaultSearchUseCase : `[`SearchUseCase`](-search-use-case/index.md) | +| [NewTabSearchUseCase](-new-tab-search-use-case/index.md) | `class NewTabSearchUseCase : `[`SearchUseCase`](-search-use-case/index.md) | +| [SearchUseCase](-search-use-case/index.md) | `interface SearchUseCase` | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SearchUseCases(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, searchEngineManager: `[`SearchEngineManager`](../../mozilla.components.browser.search/-search-engine-manager/index.md)`, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, onNoSession: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Session`](../../mozilla.components.browser.session/-session/index.md)` = { url -> + Session(url).apply { sessionManager.add(this) } + })`
Contains use cases related to the search feature. | + +### Properties + +| Name | Summary | +|---|---| +| [defaultSearch](default-search.md) | `val defaultSearch: `[`DefaultSearchUseCase`](-default-search-use-case/index.md) | +| [newTabSearch](new-tab-search.md) | `val newTabSearch: `[`NewTabSearchUseCase`](-new-tab-search-use-case/index.md) | diff --git a/docs/api/mozilla.components.feature.search/-search-use-cases/new-tab-search.md b/docs/api/mozilla.components.feature.search/-search-use-cases/new-tab-search.md new file mode 100644 index 00000000000..85d07939237 --- /dev/null +++ b/docs/api/mozilla.components.feature.search/-search-use-cases/new-tab-search.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.search](../index.md) / [SearchUseCases](index.md) / [newTabSearch](./new-tab-search.md) + +# newTabSearch + +`val newTabSearch: `[`NewTabSearchUseCase`](-new-tab-search-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/search/src/main/java/mozilla/components/feature/search/SearchUseCases.kt#L99) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.search/index.md b/docs/api/mozilla.components.feature.search/index.md new file mode 100644 index 00000000000..b9434cc092b --- /dev/null +++ b/docs/api/mozilla.components.feature.search/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.feature.search](./index.md) + +## Package mozilla.components.feature.search + +### Types + +| Name | Summary | +|---|---| +| [SearchUseCases](-search-use-cases/index.md) | `class SearchUseCases`
Contains use cases related to the search feature. | diff --git a/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/-init-.md b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/-init-.md new file mode 100644 index 00000000000..3d68b2fd6db --- /dev/null +++ b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/-init-.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.feature.session.bundling](../index.md) / [SessionBundleStorage](index.md) / [<init>](./-init-.md) + +# <init> + +`SessionBundleStorage(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, bundleLifetime: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)`>)` + +A [Session](../../mozilla.components.browser.session/-session/index.md) storage implementation that saves snapshots as a [SessionBundle](../-session-bundle/index.md). + +### Parameters + +`bundleLifetime` - The lifetime of a bundle controls whether a bundle will be restored or whether this bundle is +considered expired and a new bundle will be used. \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/auto-save.md b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/auto-save.md new file mode 100644 index 00000000000..5f462857d25 --- /dev/null +++ b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/auto-save.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.session.bundling](../index.md) / [SessionBundleStorage](index.md) / [autoSave](./auto-save.md) + +# autoSave + +`@CheckResult fun autoSave(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, interval: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = AutoSave.DEFAULT_INTERVAL_MILLISECONDS, unit: `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)` = TimeUnit.MILLISECONDS): `[`AutoSave`](../../mozilla.components.browser.session.storage/-auto-save/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session-bundling/src/main/java/mozilla/components/feature/session/bundling/SessionBundleStorage.kt#L155) + +Starts configuring automatic saving of the state. + diff --git a/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/bundles-paged.md b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/bundles-paged.md new file mode 100644 index 00000000000..2deee939992 --- /dev/null +++ b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/bundles-paged.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.feature.session.bundling](../index.md) / [SessionBundleStorage](index.md) / [bundlesPaged](./bundles-paged.md) + +# bundlesPaged + +`fun bundlesPaged(): Factory<`[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `[`SessionBundle`](../-session-bundle/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session-bundling/src/main/java/mozilla/components/feature/session/bundling/SessionBundleStorage.kt#L144) + +Returns all saved [SessionBundle](../-session-bundle/index.md) instances as a [DataSource.Factory](#). + +A consuming app can transform the data source into a `LiveData` of when using RxJava2 into a +`Flowable` or `Observable`, that can be observed. + +* https://developer.android.com/topic/libraries/architecture/paging/data +* https://developer.android.com/topic/libraries/architecture/paging/ui diff --git a/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/bundles.md b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/bundles.md new file mode 100644 index 00000000000..6eaee4eb1c8 --- /dev/null +++ b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/bundles.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.session.bundling](../index.md) / [SessionBundleStorage](index.md) / [bundles](./bundles.md) + +# bundles + +`fun bundles(limit: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 20): LiveData<`[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SessionBundle`](../-session-bundle/index.md)`>>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session-bundling/src/main/java/mozilla/components/feature/session/bundling/SessionBundleStorage.kt#L125) + +Returns the last saved [SessionBundle](../-session-bundle/index.md) instances (up to [limit](bundles.md#mozilla.components.feature.session.bundling.SessionBundleStorage$bundles(kotlin.Int)/limit)) as a [LiveData](#) list. + diff --git a/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/current.md b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/current.md new file mode 100644 index 00000000000..27b64acd515 --- /dev/null +++ b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/current.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.feature.session.bundling](../index.md) / [SessionBundleStorage](index.md) / [current](./current.md) + +# current + +`@Synchronized fun current(): `[`SessionBundle`](../-session-bundle/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session-bundling/src/main/java/mozilla/components/feature/session/bundling/SessionBundleStorage.kt#L106) + +Returns the currently used [SessionBundle](../-session-bundle/index.md) for saving [SessionManager.Snapshot](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md) instances. Or null if no bundle +is in use currently. + diff --git a/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/index.md b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/index.md new file mode 100644 index 00000000000..c9cd205d276 --- /dev/null +++ b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/index.md @@ -0,0 +1,32 @@ +[android-components](../../index.md) / [mozilla.components.feature.session.bundling](../index.md) / [SessionBundleStorage](./index.md) + +# SessionBundleStorage + +`class SessionBundleStorage : `[`Storage`](../../mozilla.components.browser.session.storage/-auto-save/-storage/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session-bundling/src/main/java/mozilla/components/feature/session/bundling/SessionBundleStorage.kt#L29) + +A [Session](../../mozilla.components.browser.session/-session/index.md) storage implementation that saves snapshots as a [SessionBundle](../-session-bundle/index.md). + +### Parameters + +`bundleLifetime` - The lifetime of a bundle controls whether a bundle will be restored or whether this bundle is +considered expired and a new bundle will be used. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SessionBundleStorage(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, bundleLifetime: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)`>)`
A [Session](../../mozilla.components.browser.session/-session/index.md) storage implementation that saves snapshots as a [SessionBundle](../-session-bundle/index.md). | + +### Functions + +| Name | Summary | +|---|---| +| [autoSave](auto-save.md) | `fun autoSave(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, interval: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = AutoSave.DEFAULT_INTERVAL_MILLISECONDS, unit: `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)` = TimeUnit.MILLISECONDS): `[`AutoSave`](../../mozilla.components.browser.session.storage/-auto-save/index.md)
Starts configuring automatic saving of the state. | +| [bundles](bundles.md) | `fun bundles(limit: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 20): LiveData<`[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`SessionBundle`](../-session-bundle/index.md)`>>`
Returns the last saved [SessionBundle](../-session-bundle/index.md) instances (up to [limit](bundles.md#mozilla.components.feature.session.bundling.SessionBundleStorage$bundles(kotlin.Int)/limit)) as a [LiveData](#) list. | +| [bundlesPaged](bundles-paged.md) | `fun bundlesPaged(): Factory<`[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `[`SessionBundle`](../-session-bundle/index.md)`>`
Returns all saved [SessionBundle](../-session-bundle/index.md) instances as a [DataSource.Factory](#). | +| [current](current.md) | `fun current(): `[`SessionBundle`](../-session-bundle/index.md)`?`
Returns the currently used [SessionBundle](../-session-bundle/index.md) for saving [SessionManager.Snapshot](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md) instances. Or null if no bundle is in use currently. | +| [remove](remove.md) | `fun remove(bundle: `[`SessionBundle`](../-session-bundle/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Removes the given [SessionBundle](../-session-bundle/index.md) permanently. If this is the active bundle then a new one will be created the next time a [SessionManager.Snapshot](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md) is saved. | +| [removeAll](remove-all.md) | `fun removeAll(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Removes all saved [SessionBundle](../-session-bundle/index.md) instances permanently. | +| [restore](restore.md) | `fun restore(): `[`SessionBundle`](../-session-bundle/index.md)`?`
Restores the last [SessionBundle](../-session-bundle/index.md) if there is one without expired lifetime. | +| [save](save.md) | `fun save(snapshot: `[`Snapshot`](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Saves the [SessionManager.Snapshot](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md) as a bundle. If a bundle was restored previously then this bundle will be updated with the data from the snapshot. If no bundle was restored a new bundle will be created. | +| [use](use.md) | `fun use(bundle: `[`SessionBundle`](../-session-bundle/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Explicitly uses the given [SessionBundle](../-session-bundle/index.md) (even if not active) to save [SessionManager.Snapshot](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md) instances to. | diff --git a/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/remove-all.md b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/remove-all.md new file mode 100644 index 00000000000..f4714e64198 --- /dev/null +++ b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/remove-all.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.session.bundling](../index.md) / [SessionBundleStorage](index.md) / [removeAll](./remove-all.md) + +# removeAll + +`@Synchronized fun removeAll(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session-bundling/src/main/java/mozilla/components/feature/session/bundling/SessionBundleStorage.kt#L96) + +Removes all saved [SessionBundle](../-session-bundle/index.md) instances permanently. + diff --git a/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/remove.md b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/remove.md new file mode 100644 index 00000000000..89ba8a46ed0 --- /dev/null +++ b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/remove.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.feature.session.bundling](../index.md) / [SessionBundleStorage](index.md) / [remove](./remove.md) + +# remove + +`@Synchronized fun remove(bundle: `[`SessionBundle`](../-session-bundle/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session-bundling/src/main/java/mozilla/components/feature/session/bundling/SessionBundleStorage.kt#L80) + +Removes the given [SessionBundle](../-session-bundle/index.md) permanently. If this is the active bundle then a new one will be created the +next time a [SessionManager.Snapshot](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md) is saved. + diff --git a/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/restore.md b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/restore.md new file mode 100644 index 00000000000..cedfbd80c6b --- /dev/null +++ b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/restore.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.session.bundling](../index.md) / [SessionBundleStorage](index.md) / [restore](./restore.md) + +# restore + +`@Synchronized fun restore(): `[`SessionBundle`](../-session-bundle/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session-bundling/src/main/java/mozilla/components/feature/session/bundling/SessionBundleStorage.kt#L45) + +Restores the last [SessionBundle](../-session-bundle/index.md) if there is one without expired lifetime. + diff --git a/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/save.md b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/save.md new file mode 100644 index 00000000000..0eb0a61a76f --- /dev/null +++ b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/save.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.feature.session.bundling](../index.md) / [SessionBundleStorage](index.md) / [save](./save.md) + +# save + +`@Synchronized fun save(snapshot: `[`Snapshot`](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session-bundling/src/main/java/mozilla/components/feature/session/bundling/SessionBundleStorage.kt#L61) + +Overrides [Storage.save](../../mozilla.components.browser.session.storage/-auto-save/-storage/save.md) + +Saves the [SessionManager.Snapshot](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md) as a bundle. If a bundle was restored previously then this bundle will be +updated with the data from the snapshot. If no bundle was restored a new bundle will be created. + diff --git a/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/use.md b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/use.md new file mode 100644 index 00000000000..219daf52470 --- /dev/null +++ b/docs/api/mozilla.components.feature.session.bundling/-session-bundle-storage/use.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.session.bundling](../index.md) / [SessionBundleStorage](index.md) / [use](./use.md) + +# use + +`@Synchronized fun use(bundle: `[`SessionBundle`](../-session-bundle/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session-bundling/src/main/java/mozilla/components/feature/session/bundling/SessionBundleStorage.kt#L114) + +Explicitly uses the given [SessionBundle](../-session-bundle/index.md) (even if not active) to save [SessionManager.Snapshot](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md) instances to. + diff --git a/docs/api/mozilla.components.feature.session.bundling/-session-bundle/id.md b/docs/api/mozilla.components.feature.session.bundling/-session-bundle/id.md new file mode 100644 index 00000000000..ec985d0f47e --- /dev/null +++ b/docs/api/mozilla.components.feature.session.bundling/-session-bundle/id.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.session.bundling](../index.md) / [SessionBundle](index.md) / [id](./id.md) + +# id + +`abstract val id: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session-bundling/src/main/java/mozilla/components/feature/session/bundling/SessionBundle.kt#L17) + +A unique ID identifying this bundle. Can be `null` if this is a new Bundle that has not been saved to disk yet. + diff --git a/docs/api/mozilla.components.feature.session.bundling/-session-bundle/index.md b/docs/api/mozilla.components.feature.session.bundling/-session-bundle/index.md new file mode 100644 index 00000000000..b9ac8c03ea3 --- /dev/null +++ b/docs/api/mozilla.components.feature.session.bundling/-session-bundle/index.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.feature.session.bundling](../index.md) / [SessionBundle](./index.md) + +# SessionBundle + +`interface SessionBundle` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session-bundling/src/main/java/mozilla/components/feature/session/bundling/SessionBundle.kt#L13) + +A bundle of sessions and their state. + +### Properties + +| Name | Summary | +|---|---| +| [id](id.md) | `abstract val id: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?`
A unique ID identifying this bundle. Can be `null` if this is a new Bundle that has not been saved to disk yet. | +| [lastSavedAt](last-saved-at.md) | `abstract val lastSavedAt: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Timestamp of the last time this bundle was saved (in milliseconds) | +| [urls](urls.md) | `abstract val urls: `[`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 URLs saved in this bundle. | + +### Functions + +| Name | Summary | +|---|---| +| [restoreSnapshot](restore-snapshot.md) | `abstract fun restoreSnapshot(engine: `[`Engine`](../../mozilla.components.concept.engine/-engine/index.md)`): `[`Snapshot`](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md)`?`
Restore a [SessionManager.Snapshot](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md) from this bundle. The returned snapshot can be used with [SessionManager](../../mozilla.components.browser.session/-session-manager/index.md) to restore the sessions and their state. | diff --git a/docs/api/mozilla.components.feature.session.bundling/-session-bundle/last-saved-at.md b/docs/api/mozilla.components.feature.session.bundling/-session-bundle/last-saved-at.md new file mode 100644 index 00000000000..de6d7bb1d34 --- /dev/null +++ b/docs/api/mozilla.components.feature.session.bundling/-session-bundle/last-saved-at.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.session.bundling](../index.md) / [SessionBundle](index.md) / [lastSavedAt](./last-saved-at.md) + +# lastSavedAt + +`abstract val lastSavedAt: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session-bundling/src/main/java/mozilla/components/feature/session/bundling/SessionBundle.kt#L27) + +Timestamp of the last time this bundle was saved (in milliseconds) + diff --git a/docs/api/mozilla.components.feature.session.bundling/-session-bundle/restore-snapshot.md b/docs/api/mozilla.components.feature.session.bundling/-session-bundle/restore-snapshot.md new file mode 100644 index 00000000000..ffeaf30e074 --- /dev/null +++ b/docs/api/mozilla.components.feature.session.bundling/-session-bundle/restore-snapshot.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.feature.session.bundling](../index.md) / [SessionBundle](index.md) / [restoreSnapshot](./restore-snapshot.md) + +# restoreSnapshot + +`abstract fun restoreSnapshot(engine: `[`Engine`](../../mozilla.components.concept.engine/-engine/index.md)`): `[`Snapshot`](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session-bundling/src/main/java/mozilla/components/feature/session/bundling/SessionBundle.kt#L33) + +Restore a [SessionManager.Snapshot](../../mozilla.components.browser.session/-session-manager/-snapshot/index.md) from this bundle. The returned snapshot can be used with [SessionManager](../../mozilla.components.browser.session/-session-manager/index.md) to +restore the sessions and their state. + diff --git a/docs/api/mozilla.components.feature.session.bundling/-session-bundle/urls.md b/docs/api/mozilla.components.feature.session.bundling/-session-bundle/urls.md new file mode 100644 index 00000000000..43d4c78a504 --- /dev/null +++ b/docs/api/mozilla.components.feature.session.bundling/-session-bundle/urls.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.session.bundling](../index.md) / [SessionBundle](index.md) / [urls](./urls.md) + +# urls + +`abstract val urls: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session-bundling/src/main/java/mozilla/components/feature/session/bundling/SessionBundle.kt#L22) + +List of URLs saved in this bundle. + diff --git a/docs/api/mozilla.components.feature.session.bundling/index.md b/docs/api/mozilla.components.feature.session.bundling/index.md new file mode 100644 index 00000000000..49726c295e9 --- /dev/null +++ b/docs/api/mozilla.components.feature.session.bundling/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.feature.session.bundling](./index.md) + +## Package mozilla.components.feature.session.bundling + +### Types + +| Name | Summary | +|---|---| +| [SessionBundle](-session-bundle/index.md) | `interface SessionBundle`
A bundle of sessions and their state. | +| [SessionBundleStorage](-session-bundle-storage/index.md) | `class SessionBundleStorage : `[`Storage`](../mozilla.components.browser.session.storage/-auto-save/-storage/index.md)
A [Session](../mozilla.components.browser.session/-session/index.md) storage implementation that saves snapshots as a [SessionBundle](-session-bundle/index.md). | diff --git a/docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/-d-e-f-a-u-l-t_-s-c-r-o-l-l_-f-l-a-g-s.md b/docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/-d-e-f-a-u-l-t_-s-c-r-o-l-l_-f-l-a-g-s.md new file mode 100644 index 00000000000..db6d1747b1d --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/-d-e-f-a-u-l-t_-s-c-r-o-l-l_-f-l-a-g-s.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [CoordinateScrollingFeature](index.md) / [DEFAULT_SCROLL_FLAGS](./-d-e-f-a-u-l-t_-s-c-r-o-l-l_-f-l-a-g-s.md) + +# DEFAULT_SCROLL_FLAGS + +`const val DEFAULT_SCROLL_FLAGS: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/CoordinateScrollingFeature.kt#L53) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/-init-.md b/docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/-init-.md new file mode 100644 index 00000000000..22b35486423 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/-init-.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [CoordinateScrollingFeature](index.md) / [<init>](./-init-.md) + +# <init> + +`CoordinateScrollingFeature(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, engineView: `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`, scrollFlags: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = DEFAULT_SCROLL_FLAGS)` + +Feature implementation for connecting an [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) with any View that you want to coordinate scrolling +behavior with. + +A use case could be collapsing a toolbar every time that the user scrolls. + diff --git a/docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/index.md b/docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/index.md new file mode 100644 index 00000000000..77e5c2816b3 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/index.md @@ -0,0 +1,44 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [CoordinateScrollingFeature](./index.md) + +# CoordinateScrollingFeature + +`class CoordinateScrollingFeature : `[`SelectionAwareSessionObserver`](../../mozilla.components.browser.session/-selection-aware-session-observer/index.md)`, `[`LifecycleAwareFeature`](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/CoordinateScrollingFeature.kt#L25) + +Feature implementation for connecting an [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) with any View that you want to coordinate scrolling +behavior with. + +A use case could be collapsing a toolbar every time that the user scrolls. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `CoordinateScrollingFeature(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, engineView: `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`, scrollFlags: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = DEFAULT_SCROLL_FLAGS)`
Feature implementation for connecting an [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) with any View that you want to coordinate scrolling behavior with. | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [activeSession](../../mozilla.components.browser.session/-selection-aware-session-observer/active-session.md) | `open var activeSession: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`?`
the currently observed session | + +### Functions + +| Name | Summary | +|---|---| +| [onLoadingStateChanged](on-loading-state-changed.md) | `fun onLoadingStateChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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) | +| [start](start.md) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Start feature: Starts adding scrolling behavior for the indicated view. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [observeFixed](../../mozilla.components.browser.session/-selection-aware-session-observer/observe-fixed.md) | `fun observeFixed(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts observing changes to the specified session. | +| [observeSelected](../../mozilla.components.browser.session/-selection-aware-session-observer/observe-selected.md) | `fun observeSelected(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts observing changes to the selected session (see [SessionManager.selectedSession](../../mozilla.components.browser.session/-session-manager/selected-session.md)). If a different session is selected the observer will automatically be switched over and only notified of changes to the newly selected session. | +| [onSessionSelected](../../mozilla.components.browser.session/-selection-aware-session-observer/on-session-selected.md) | `open fun onSessionSelected(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`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. | +| [stop](../../mozilla.components.browser.session/-selection-aware-session-observer/stop.md) | `open fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stops the observer. | + +### Companion Object Properties + +| Name | Summary | +|---|---| +| [DEFAULT_SCROLL_FLAGS](-d-e-f-a-u-l-t_-s-c-r-o-l-l_-f-l-a-g-s.md) | `const val DEFAULT_SCROLL_FLAGS: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/on-loading-state-changed.md b/docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/on-loading-state-changed.md new file mode 100644 index 00000000000..ae5ac929291 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/on-loading-state-changed.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [CoordinateScrollingFeature](index.md) / [onLoadingStateChanged](./on-loading-state-changed.md) + +# onLoadingStateChanged + +`fun onLoadingStateChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/CoordinateScrollingFeature.kt#L39) + +Overrides [Observer.onLoadingStateChanged](../../mozilla.components.browser.session/-session/-observer/on-loading-state-changed.md) + diff --git a/docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/start.md b/docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/start.md new file mode 100644 index 00000000000..4ea79b538f5 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-coordinate-scrolling-feature/start.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [CoordinateScrollingFeature](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/CoordinateScrollingFeature.kt#L35) + +Overrides [LifecycleAwareFeature.start](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/start.md) + +Start feature: Starts adding scrolling behavior for the indicated view. + diff --git a/docs/api/mozilla.components.feature.session/-engine-view-presenter/-init-.md b/docs/api/mozilla.components.feature.session/-engine-view-presenter/-init-.md new file mode 100644 index 00000000000..35ccdfc1fe5 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-engine-view-presenter/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [EngineViewPresenter](index.md) / [<init>](./-init-.md) + +# <init> + +`EngineViewPresenter(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, engineView: `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md)`, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)` + +Presenter implementation for EngineView. + diff --git a/docs/api/mozilla.components.feature.session/-engine-view-presenter/index.md b/docs/api/mozilla.components.feature.session/-engine-view-presenter/index.md new file mode 100644 index 00000000000..54a8bf4d55e --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-engine-view-presenter/index.md @@ -0,0 +1,30 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [EngineViewPresenter](./index.md) + +# EngineViewPresenter + +`class EngineViewPresenter : `[`Observer`](../../mozilla.components.browser.session/-session-manager/-observer/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/EngineViewPresenter.kt#L14) + +Presenter implementation for EngineView. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `EngineViewPresenter(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, engineView: `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md)`, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)`
Presenter implementation for EngineView. | + +### Functions + +| Name | Summary | +|---|---| +| [onSessionSelected](on-session-selected.md) | `fun onSessionSelected(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`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.md) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Start presenter and display data in view. | +| [stop](stop.md) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stop presenter from updating view. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [onAllSessionsRemoved](../../mozilla.components.browser.session/-session-manager/-observer/on-all-sessions-removed.md) | `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](../../mozilla.components.browser.session/-session-manager/-observer/on-session-added.md) | `open fun onSessionAdded(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
The given session has been added. | +| [onSessionRemoved](../../mozilla.components.browser.session/-session-manager/-observer/on-session-removed.md) | `open fun onSessionRemoved(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
The given session has been removed. | +| [onSessionsRestored](../../mozilla.components.browser.session/-session-manager/-observer/on-sessions-restored.md) | `open fun onSessionsRestored(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Sessions have been restored via a snapshot. This callback is invoked at the end of the call to read, after every session in the snapshot was added, and appropriate session was selected. | diff --git a/docs/api/mozilla.components.feature.session/-engine-view-presenter/on-session-selected.md b/docs/api/mozilla.components.feature.session/-engine-view-presenter/on-session-selected.md new file mode 100644 index 00000000000..704e69cb399 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-engine-view-presenter/on-session-selected.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [EngineViewPresenter](index.md) / [onSessionSelected](./on-session-selected.md) + +# onSessionSelected + +`fun onSessionSelected(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/EngineViewPresenter.kt#L46) + +Overrides [Observer.onSessionSelected](../../mozilla.components.browser.session/-session-manager/-observer/on-session-selected.md) + +A new session has been selected: Render it on an EngineView. + diff --git a/docs/api/mozilla.components.feature.session/-engine-view-presenter/start.md b/docs/api/mozilla.components.feature.session/-engine-view-presenter/start.md new file mode 100644 index 00000000000..f37f7fd6db0 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-engine-view-presenter/start.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [EngineViewPresenter](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/EngineViewPresenter.kt#L23) + +Start presenter and display data in view. + diff --git a/docs/api/mozilla.components.feature.session/-engine-view-presenter/stop.md b/docs/api/mozilla.components.feature.session/-engine-view-presenter/stop.md new file mode 100644 index 00000000000..241e7b99c4f --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-engine-view-presenter/stop.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [EngineViewPresenter](index.md) / [stop](./stop.md) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/EngineViewPresenter.kt#L37) + +Stop presenter from updating view. + diff --git a/docs/api/mozilla.components.feature.session/-full-screen-feature/-init-.md b/docs/api/mozilla.components.feature.session/-full-screen-feature/-init-.md new file mode 100644 index 00000000000..ddb680eab50 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-full-screen-feature/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [FullScreenFeature](index.md) / [<init>](./-init-.md) + +# <init> + +`FullScreenFeature(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, sessionUseCases: `[`SessionUseCases`](../-session-use-cases/index.md)`, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, fullScreenChanged: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +Feature implementation for handling fullscreen mode (exiting and back button presses). + diff --git a/docs/api/mozilla.components.feature.session/-full-screen-feature/index.md b/docs/api/mozilla.components.feature.session/-full-screen-feature/index.md new file mode 100644 index 00000000000..9c11fd62c94 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-full-screen-feature/index.md @@ -0,0 +1,36 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [FullScreenFeature](./index.md) + +# FullScreenFeature + +`open class FullScreenFeature : `[`SelectionAwareSessionObserver`](../../mozilla.components.browser.session/-selection-aware-session-observer/index.md)`, `[`LifecycleAwareFeature`](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)`, `[`BackHandler`](../../mozilla.components.support.base.feature/-back-handler/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/FullScreenFeature.kt#L18) + +Feature implementation for handling fullscreen mode (exiting and back button presses). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FullScreenFeature(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, sessionUseCases: `[`SessionUseCases`](../-session-use-cases/index.md)`, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, fullScreenChanged: (`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
Feature implementation for handling fullscreen mode (exiting and back button presses). | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [activeSession](../../mozilla.components.browser.session/-selection-aware-session-observer/active-session.md) | `open var activeSession: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`?`
the currently observed session | + +### Functions + +| Name | Summary | +|---|---| +| [onBackPressed](on-back-pressed.md) | `open fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
To be called when the back button is pressed, so that only fullscreen mode closes. | +| [onFullScreenChanged](on-full-screen-changed.md) | `open fun onFullScreenChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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) | +| [start](start.md) | `open fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts the feature and a observer to listen for fullscreen changes. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [observeFixed](../../mozilla.components.browser.session/-selection-aware-session-observer/observe-fixed.md) | `fun observeFixed(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts observing changes to the specified session. | +| [observeSelected](../../mozilla.components.browser.session/-selection-aware-session-observer/observe-selected.md) | `fun observeSelected(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts observing changes to the selected session (see [SessionManager.selectedSession](../../mozilla.components.browser.session/-session-manager/selected-session.md)). If a different session is selected the observer will automatically be switched over and only notified of changes to the newly selected session. | +| [onSessionSelected](../../mozilla.components.browser.session/-selection-aware-session-observer/on-session-selected.md) | `open fun onSessionSelected(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`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. | +| [stop](../../mozilla.components.browser.session/-selection-aware-session-observer/stop.md) | `open fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stops the observer. | diff --git a/docs/api/mozilla.components.feature.session/-full-screen-feature/on-back-pressed.md b/docs/api/mozilla.components.feature.session/-full-screen-feature/on-back-pressed.md new file mode 100644 index 00000000000..9a7f4c63296 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-full-screen-feature/on-back-pressed.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [FullScreenFeature](index.md) / [onBackPressed](./on-back-pressed.md) + +# onBackPressed + +`open fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/FullScreenFeature.kt#L40) + +Overrides [BackHandler.onBackPressed](../../mozilla.components.support.base.feature/-back-handler/on-back-pressed.md) + +To be called when the back button is pressed, so that only fullscreen mode closes. + +**Return** +Returns true if the fullscreen mode was successfully exited; false if no effect was taken. + diff --git a/docs/api/mozilla.components.feature.session/-full-screen-feature/on-full-screen-changed.md b/docs/api/mozilla.components.feature.session/-full-screen-feature/on-full-screen-changed.md new file mode 100644 index 00000000000..6fcb1ef1274 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-full-screen-feature/on-full-screen-changed.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [FullScreenFeature](index.md) / [onFullScreenChanged](./on-full-screen-changed.md) + +# onFullScreenChanged + +`open fun onFullScreenChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/FullScreenFeature.kt#L33) + +Overrides [Observer.onFullScreenChanged](../../mozilla.components.browser.session/-session/-observer/on-full-screen-changed.md) + diff --git a/docs/api/mozilla.components.feature.session/-full-screen-feature/start.md b/docs/api/mozilla.components.feature.session/-full-screen-feature/start.md new file mode 100644 index 00000000000..3b53736c9fe --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-full-screen-feature/start.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [FullScreenFeature](index.md) / [start](./start.md) + +# start + +`open fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/FullScreenFeature.kt#L28) + +Overrides [LifecycleAwareFeature.start](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/start.md) + +Starts the feature and a observer to listen for fullscreen changes. + diff --git a/docs/api/mozilla.components.feature.session/-history-delegate/-init-.md b/docs/api/mozilla.components.feature.session/-history-delegate/-init-.md new file mode 100644 index 00000000000..c6088f03ce2 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-history-delegate/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [HistoryDelegate](index.md) / [<init>](./-init-.md) + +# <init> + +`HistoryDelegate(historyStorage: `[`HistoryStorage`](../../mozilla.components.concept.storage/-history-storage/index.md)`)` + +Implementation of the [HistoryTrackingDelegate](../../mozilla.components.concept.engine.history/-history-tracking-delegate/index.md) which delegates work to an instance of [HistoryStorage](../../mozilla.components.concept.storage/-history-storage/index.md). + diff --git a/docs/api/mozilla.components.feature.session/-history-delegate/get-visited.md b/docs/api/mozilla.components.feature.session/-history-delegate/get-visited.md new file mode 100644 index 00000000000..cd533721f3a --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-history-delegate/get-visited.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [HistoryDelegate](index.md) / [getVisited](./get-visited.md) + +# getVisited + +`suspend fun getVisited(uris: `[`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`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/HistoryDelegate.kt#L28) + +Overrides [HistoryTrackingDelegate.getVisited](../../mozilla.components.concept.engine.history/-history-tracking-delegate/get-visited.md) + +An engine needs to know "visited" (true/false) status for provided URIs. + +`suspend fun getVisited(): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/HistoryDelegate.kt#L32) + +Overrides [HistoryTrackingDelegate.getVisited](../../mozilla.components.concept.engine.history/-history-tracking-delegate/get-visited.md) + +An engine needs to know a list of all visited URIs. + diff --git a/docs/api/mozilla.components.feature.session/-history-delegate/index.md b/docs/api/mozilla.components.feature.session/-history-delegate/index.md new file mode 100644 index 00000000000..79f50724d94 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-history-delegate/index.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [HistoryDelegate](./index.md) + +# HistoryDelegate + +`class HistoryDelegate : `[`HistoryTrackingDelegate`](../../mozilla.components.concept.engine.history/-history-tracking-delegate/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/HistoryDelegate.kt#L15) + +Implementation of the [HistoryTrackingDelegate](../../mozilla.components.concept.engine.history/-history-tracking-delegate/index.md) which delegates work to an instance of [HistoryStorage](../../mozilla.components.concept.storage/-history-storage/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `HistoryDelegate(historyStorage: `[`HistoryStorage`](../../mozilla.components.concept.storage/-history-storage/index.md)`)`
Implementation of the [HistoryTrackingDelegate](../../mozilla.components.concept.engine.history/-history-tracking-delegate/index.md) which delegates work to an instance of [HistoryStorage](../../mozilla.components.concept.storage/-history-storage/index.md). | + +### Functions + +| Name | Summary | +|---|---| +| [getVisited](get-visited.md) | `suspend fun getVisited(uris: `[`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`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>`
An engine needs to know "visited" (true/false) status for provided URIs.`suspend fun getVisited(): `[`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)`>`
An engine needs to know a list of all visited URIs. | +| [onTitleChanged](on-title-changed.md) | `suspend fun onTitleChanged(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/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)
Title changed for a given URI. | +| [onVisited](on-visited.md) | `suspend fun onVisited(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, isReload: `[`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 URI visit happened that an engine considers worthy of being recorded in browser's history. | diff --git a/docs/api/mozilla.components.feature.session/-history-delegate/on-title-changed.md b/docs/api/mozilla.components.feature.session/-history-delegate/on-title-changed.md new file mode 100644 index 00000000000..69737d83ffb --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-history-delegate/on-title-changed.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [HistoryDelegate](index.md) / [onTitleChanged](./on-title-changed.md) + +# onTitleChanged + +`suspend fun onTitleChanged(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/HistoryDelegate.kt#L24) + +Overrides [HistoryTrackingDelegate.onTitleChanged](../../mozilla.components.concept.engine.history/-history-tracking-delegate/on-title-changed.md) + +Title changed for a given URI. + diff --git a/docs/api/mozilla.components.feature.session/-history-delegate/on-visited.md b/docs/api/mozilla.components.feature.session/-history-delegate/on-visited.md new file mode 100644 index 00000000000..b5bb4bb16f9 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-history-delegate/on-visited.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [HistoryDelegate](index.md) / [onVisited](./on-visited.md) + +# onVisited + +`suspend fun onVisited(uri: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, isReload: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/HistoryDelegate.kt#L16) + +Overrides [HistoryTrackingDelegate.onVisited](../../mozilla.components.concept.engine.history/-history-tracking-delegate/on-visited.md) + +A URI visit happened that an engine considers worthy of being recorded in browser's history. + diff --git a/docs/api/mozilla.components.feature.session/-session-feature/-init-.md b/docs/api/mozilla.components.feature.session/-session-feature/-init-.md new file mode 100644 index 00000000000..d8a342a43cf --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-feature/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [SessionFeature](index.md) / [<init>](./-init-.md) + +# <init> + +`SessionFeature(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, sessionUseCases: `[`SessionUseCases`](../-session-use-cases/index.md)`, engineView: `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md)`, 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/mozilla.components.feature.session/-session-feature/index.md b/docs/api/mozilla.components.feature.session/-session-feature/index.md new file mode 100644 index 00000000000..7a966af9799 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-feature/index.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [SessionFeature](./index.md) + +# SessionFeature + +`class SessionFeature : `[`LifecycleAwareFeature`](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)`, `[`BackHandler`](../../mozilla.components.support.base.feature/-back-handler/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionFeature.kt#L15) + +Feature implementation for connecting the engine module with the session module. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SessionFeature(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, sessionUseCases: `[`SessionUseCases`](../-session-use-cases/index.md)`, engineView: `[`EngineView`](../../mozilla.components.concept.engine/-engine-view/index.md)`, 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 + +| Name | Summary | +|---|---| +| [onBackPressed](on-back-pressed.md) | `fun onBackPressed(): `[`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.md) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Start feature: App is in the foreground. | +| [stop](stop.md) | `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/mozilla.components.feature.session/-session-feature/on-back-pressed.md b/docs/api/mozilla.components.feature.session/-session-feature/on-back-pressed.md new file mode 100644 index 00000000000..6654bf55e9a --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-feature/on-back-pressed.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [SessionFeature](index.md) / [onBackPressed](./on-back-pressed.md) + +# onBackPressed + +`fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionFeature.kt#L35) + +Overrides [BackHandler.onBackPressed](../../mozilla.components.support.base.feature/-back-handler/on-back-pressed.md) + +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/mozilla.components.feature.session/-session-feature/start.md b/docs/api/mozilla.components.feature.session/-session-feature/start.md new file mode 100644 index 00000000000..0f9f7f2c62b --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-feature/start.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [SessionFeature](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionFeature.kt#L26) + +Overrides [LifecycleAwareFeature.start](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/start.md) + +Start feature: App is in the foreground. + diff --git a/docs/api/mozilla.components.feature.session/-session-feature/stop.md b/docs/api/mozilla.components.feature.session/-session-feature/stop.md new file mode 100644 index 00000000000..d1818a7c405 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-feature/stop.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [SessionFeature](index.md) / [stop](./stop.md) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionFeature.kt#L51) + +Overrides [LifecycleAwareFeature.stop](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/stop.md) + +Stop feature: App is in the background. + diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/-clear-data-use-case/index.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-clear-data-use-case/index.md new file mode 100644 index 00000000000..27f48aa772e --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-clear-data-use-case/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [ClearDataUseCase](./index.md) + +# ClearDataUseCase + +`class ClearDataUseCase` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L164) + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `fun invoke(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Clears all user data sources available. | diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/-clear-data-use-case/invoke.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-clear-data-use-case/invoke.md new file mode 100644 index 00000000000..e0e2222a7c4 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-clear-data-use-case/invoke.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [ClearDataUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`fun invoke(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L170) + +Clears all user data sources available. + diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/-default-load-url-use-case/index.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-default-load-url-use-case/index.md new file mode 100644 index 00000000000..a54b6ddc73f --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-default-load-url-use-case/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [DefaultLoadUrlUseCase](./index.md) + +# DefaultLoadUrlUseCase + +`class DefaultLoadUrlUseCase : `[`LoadUrlUseCase`](../-load-url-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L32) + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `fun invoke(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 provided URL using the currently selected session. If there's no selected session a new session will be created using [onNoSession](#).`fun invoke(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Loads the provided URL using the specified session. If no session is provided the currently selected session will be used. If there's no selected session a new session will be created using [onNoSession](#). | diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/-default-load-url-use-case/invoke.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-default-load-url-use-case/invoke.md new file mode 100644 index 00000000000..d222d4fc7db --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-default-load-url-use-case/invoke.md @@ -0,0 +1,25 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [DefaultLoadUrlUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`fun invoke(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L44) + +Overrides [LoadUrlUseCase.invoke](../-load-url-use-case/invoke.md) + +Loads the provided URL using the currently selected session. If +there's no selected session a new session will be created using +[onNoSession](#). + +### Parameters + +`url` - The URL to be loaded using the selected session.`fun invoke(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L56) + +Loads the provided URL using the specified session. If no session +is provided the currently selected session will be used. If there's +no selected session a new session will be created using [onNoSession](#). + +### Parameters + +`url` - The URL to be loaded using the provided session. + +`session` - the session for which the URL should be loaded. \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/-exit-full-screen-use-case/index.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-exit-full-screen-use-case/index.md new file mode 100644 index 00000000000..89478575723 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-exit-full-screen-use-case/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [ExitFullScreenUseCase](./index.md) + +# ExitFullScreenUseCase + +`class ExitFullScreenUseCase` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L151) + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `fun invoke(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Exits fullscreen mode of the current session. | diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/-exit-full-screen-use-case/invoke.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-exit-full-screen-use-case/invoke.md new file mode 100644 index 00000000000..bc97aa6fd55 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-exit-full-screen-use-case/invoke.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [ExitFullScreenUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`fun invoke(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L157) + +Exits fullscreen mode of the current session. + diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/-go-back-use-case/index.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-go-back-use-case/index.md new file mode 100644 index 00000000000..ff4b7be8b6b --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-go-back-use-case/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [GoBackUseCase](./index.md) + +# GoBackUseCase + +`class GoBackUseCase` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L112) + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `fun invoke(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`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/mozilla.components.feature.session/-session-use-cases/-go-back-use-case/invoke.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-go-back-use-case/invoke.md new file mode 100644 index 00000000000..0f076dfd16f --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-go-back-use-case/invoke.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [GoBackUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`fun invoke(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L118) + +Navigates back in the history of the currently selected session + diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/-go-forward-use-case/index.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-go-forward-use-case/index.md new file mode 100644 index 00000000000..fee36220925 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-go-forward-use-case/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [GoForwardUseCase](./index.md) + +# GoForwardUseCase + +`class GoForwardUseCase` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L125) + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `fun invoke(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`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/mozilla.components.feature.session/-session-use-cases/-go-forward-use-case/invoke.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-go-forward-use-case/invoke.md new file mode 100644 index 00000000000..10e9512e55f --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-go-forward-use-case/invoke.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [GoForwardUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`fun invoke(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L131) + +Navigates forward in the history of the currently selected session + diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/-init-.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-init-.md new file mode 100644 index 00000000000..1f5ea3d3b61 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-init-.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [SessionUseCases](index.md) / [<init>](./-init-.md) + +# <init> + +`SessionUseCases(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, onNoSession: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Session`](../../mozilla.components.browser.session/-session/index.md)` = { url -> + Session(url).apply { sessionManager.add(this) } + })` + +Contains use cases related to the session feature. + +### Parameters + +`sessionManager` - the application's [SessionManager](../../mozilla.components.browser.session/-session-manager/index.md). + +`onNoSession` - When invoking a use case that requires a (selected) [Session](../../mozilla.components.browser.session/-session/index.md) and when no [Session](../../mozilla.components.browser.session/-session/index.md) is available +this (optional) lambda will be invoked to create a [Session](../../mozilla.components.browser.session/-session/index.md). The default implementation creates a [Session](../../mozilla.components.browser.session/-session/index.md) and adds +it to the [SessionManager](../../mozilla.components.browser.session/-session-manager/index.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/-load-data-use-case/index.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-load-data-use-case/index.md new file mode 100644 index 00000000000..adc6e4bfc0c --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-load-data-use-case/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [LoadDataUseCase](./index.md) + +# LoadDataUseCase + +`class LoadDataUseCase` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L62) + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `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`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`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/mozilla.components.feature.session/-session-use-cases/-load-data-use-case/invoke.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-load-data-use-case/invoke.md new file mode 100644 index 00000000000..5f10b7a2049 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-load-data-use-case/invoke.md @@ -0,0 +1,9 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [LoadDataUseCase](index.md) / [invoke](./invoke.md) + +# 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`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L70) + +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/mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md new file mode 100644 index 00000000000..b20f6816dc5 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md @@ -0,0 +1,21 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [LoadUrlUseCase](./index.md) + +# LoadUrlUseCase + +`interface LoadUrlUseCase` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L28) + +Contract for use cases that load a provided URL. + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `abstract fun invoke(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) | + +### Inheritors + +| Name | Summary | +|---|---| +| [AddNewPrivateTabUseCase](../../../mozilla.components.feature.tabs/-tabs-use-cases/-add-new-private-tab-use-case/index.md) | `class AddNewPrivateTabUseCase : `[`LoadUrlUseCase`](./index.md) | +| [AddNewTabUseCase](../../../mozilla.components.feature.tabs/-tabs-use-cases/-add-new-tab-use-case/index.md) | `class AddNewTabUseCase : `[`LoadUrlUseCase`](./index.md) | +| [DefaultLoadUrlUseCase](../-default-load-url-use-case/index.md) | `class DefaultLoadUrlUseCase : `[`LoadUrlUseCase`](./index.md) | diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/-load-url-use-case/invoke.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-load-url-use-case/invoke.md new file mode 100644 index 00000000000..a4da08b527f --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-load-url-use-case/invoke.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [LoadUrlUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`abstract fun invoke(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L29) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/-reload-url-use-case/index.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-reload-url-use-case/index.md new file mode 100644 index 00000000000..b603417a601 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-reload-url-use-case/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [ReloadUrlUseCase](./index.md) + +# ReloadUrlUseCase + +`class ReloadUrlUseCase` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L81) + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `fun invoke(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`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/mozilla.components.feature.session/-session-use-cases/-reload-url-use-case/invoke.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-reload-url-use-case/invoke.md new file mode 100644 index 00000000000..0dc31ab7164 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-reload-url-use-case/invoke.md @@ -0,0 +1,12 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [ReloadUrlUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`fun invoke(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L90) + +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/mozilla.components.feature.session/-session-use-cases/-request-desktop-site-use-case/index.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-request-desktop-site-use-case/index.md new file mode 100644 index 00000000000..2135674aacf --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-request-desktop-site-use-case/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [RequestDesktopSiteUseCase](./index.md) + +# RequestDesktopSiteUseCase + +`class RequestDesktopSiteUseCase` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L138) + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `fun invoke(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Requests the desktop version of the current session and reloads the page. | diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/-request-desktop-site-use-case/invoke.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-request-desktop-site-use-case/invoke.md new file mode 100644 index 00000000000..db4050933e1 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-request-desktop-site-use-case/invoke.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [RequestDesktopSiteUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`fun invoke(enable: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L144) + +Requests the desktop version of the current session and reloads the page. + diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/-stop-loading-use-case/index.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-stop-loading-use-case/index.md new file mode 100644 index 00000000000..8cce52607f3 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-stop-loading-use-case/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [StopLoadingUseCase](./index.md) + +# StopLoadingUseCase + +`class StopLoadingUseCase` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L97) + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `fun invoke(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`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/mozilla.components.feature.session/-session-use-cases/-stop-loading-use-case/invoke.md b/docs/api/mozilla.components.feature.session/-session-use-cases/-stop-loading-use-case/invoke.md new file mode 100644 index 00000000000..78d5636ddaa --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/-stop-loading-use-case/invoke.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.session](../../index.md) / [SessionUseCases](../index.md) / [StopLoadingUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`fun invoke(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = sessionManager.selectedSession): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L105) + +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/mozilla.components.feature.session/-session-use-cases/clear-data.md b/docs/api/mozilla.components.feature.session/-session-use-cases/clear-data.md new file mode 100644 index 00000000000..d9470799cb3 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/clear-data.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [SessionUseCases](index.md) / [clearData](./clear-data.md) + +# clearData + +`val clearData: `[`ClearDataUseCase`](-clear-data-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L185) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/exit-fullscreen.md b/docs/api/mozilla.components.feature.session/-session-use-cases/exit-fullscreen.md new file mode 100644 index 00000000000..95cb499576e --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/exit-fullscreen.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [SessionUseCases](index.md) / [exitFullscreen](./exit-fullscreen.md) + +# exitFullscreen + +`val exitFullscreen: `[`ExitFullScreenUseCase`](-exit-full-screen-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L184) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/go-back.md b/docs/api/mozilla.components.feature.session/-session-use-cases/go-back.md new file mode 100644 index 00000000000..c812584aede --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/go-back.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [SessionUseCases](index.md) / [goBack](./go-back.md) + +# goBack + +`val goBack: `[`GoBackUseCase`](-go-back-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L181) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/go-forward.md b/docs/api/mozilla.components.feature.session/-session-use-cases/go-forward.md new file mode 100644 index 00000000000..54d41049a10 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/go-forward.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [SessionUseCases](index.md) / [goForward](./go-forward.md) + +# goForward + +`val goForward: `[`GoForwardUseCase`](-go-forward-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L182) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/index.md b/docs/api/mozilla.components.feature.session/-session-use-cases/index.md new file mode 100644 index 00000000000..6b97e314778 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/index.md @@ -0,0 +1,52 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [SessionUseCases](./index.md) + +# SessionUseCases + +`class SessionUseCases` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L18) + +Contains use cases related to the session feature. + +### Parameters + +`sessionManager` - the application's [SessionManager](../../mozilla.components.browser.session/-session-manager/index.md). + +`onNoSession` - When invoking a use case that requires a (selected) [Session](../../mozilla.components.browser.session/-session/index.md) and when no [Session](../../mozilla.components.browser.session/-session/index.md) is available +this (optional) lambda will be invoked to create a [Session](../../mozilla.components.browser.session/-session/index.md). The default implementation creates a [Session](../../mozilla.components.browser.session/-session/index.md) and adds +it to the [SessionManager](../../mozilla.components.browser.session/-session-manager/index.md). + +### Types + +| Name | Summary | +|---|---| +| [ClearDataUseCase](-clear-data-use-case/index.md) | `class ClearDataUseCase` | +| [DefaultLoadUrlUseCase](-default-load-url-use-case/index.md) | `class DefaultLoadUrlUseCase : `[`LoadUrlUseCase`](-load-url-use-case/index.md) | +| [ExitFullScreenUseCase](-exit-full-screen-use-case/index.md) | `class ExitFullScreenUseCase` | +| [GoBackUseCase](-go-back-use-case/index.md) | `class GoBackUseCase` | +| [GoForwardUseCase](-go-forward-use-case/index.md) | `class GoForwardUseCase` | +| [LoadDataUseCase](-load-data-use-case/index.md) | `class LoadDataUseCase` | +| [LoadUrlUseCase](-load-url-use-case/index.md) | `interface LoadUrlUseCase`
Contract for use cases that load a provided URL. | +| [ReloadUrlUseCase](-reload-url-use-case/index.md) | `class ReloadUrlUseCase` | +| [RequestDesktopSiteUseCase](-request-desktop-site-use-case/index.md) | `class RequestDesktopSiteUseCase` | +| [StopLoadingUseCase](-stop-loading-use-case/index.md) | `class StopLoadingUseCase` | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SessionUseCases(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, onNoSession: (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Session`](../../mozilla.components.browser.session/-session/index.md)` = { url -> + Session(url).apply { sessionManager.add(this) } + })`
Contains use cases related to the session feature. | + +### Properties + +| Name | Summary | +|---|---| +| [clearData](clear-data.md) | `val clearData: `[`ClearDataUseCase`](-clear-data-use-case/index.md) | +| [exitFullscreen](exit-fullscreen.md) | `val exitFullscreen: `[`ExitFullScreenUseCase`](-exit-full-screen-use-case/index.md) | +| [goBack](go-back.md) | `val goBack: `[`GoBackUseCase`](-go-back-use-case/index.md) | +| [goForward](go-forward.md) | `val goForward: `[`GoForwardUseCase`](-go-forward-use-case/index.md) | +| [loadData](load-data.md) | `val loadData: `[`LoadDataUseCase`](-load-data-use-case/index.md) | +| [loadUrl](load-url.md) | `val loadUrl: `[`DefaultLoadUrlUseCase`](-default-load-url-use-case/index.md) | +| [reload](reload.md) | `val reload: `[`ReloadUrlUseCase`](-reload-url-use-case/index.md) | +| [requestDesktopSite](request-desktop-site.md) | `val requestDesktopSite: `[`RequestDesktopSiteUseCase`](-request-desktop-site-use-case/index.md) | +| [stopLoading](stop-loading.md) | `val stopLoading: `[`StopLoadingUseCase`](-stop-loading-use-case/index.md) | diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/load-data.md b/docs/api/mozilla.components.feature.session/-session-use-cases/load-data.md new file mode 100644 index 00000000000..2b4bd578130 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/load-data.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [SessionUseCases](index.md) / [loadData](./load-data.md) + +# loadData + +`val loadData: `[`LoadDataUseCase`](-load-data-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L178) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/load-url.md b/docs/api/mozilla.components.feature.session/-session-use-cases/load-url.md new file mode 100644 index 00000000000..ca6ff179ee6 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/load-url.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [SessionUseCases](index.md) / [loadUrl](./load-url.md) + +# loadUrl + +`val loadUrl: `[`DefaultLoadUrlUseCase`](-default-load-url-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L177) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/reload.md b/docs/api/mozilla.components.feature.session/-session-use-cases/reload.md new file mode 100644 index 00000000000..9c5fdb3d51d --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/reload.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [SessionUseCases](index.md) / [reload](./reload.md) + +# reload + +`val reload: `[`ReloadUrlUseCase`](-reload-url-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L179) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/request-desktop-site.md b/docs/api/mozilla.components.feature.session/-session-use-cases/request-desktop-site.md new file mode 100644 index 00000000000..087db32eaf1 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/request-desktop-site.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [SessionUseCases](index.md) / [requestDesktopSite](./request-desktop-site.md) + +# requestDesktopSite + +`val requestDesktopSite: `[`RequestDesktopSiteUseCase`](-request-desktop-site-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L183) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.session/-session-use-cases/stop-loading.md b/docs/api/mozilla.components.feature.session/-session-use-cases/stop-loading.md new file mode 100644 index 00000000000..0ca87230ed8 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-session-use-cases/stop-loading.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [SessionUseCases](index.md) / [stopLoading](./stop-loading.md) + +# stopLoading + +`val stopLoading: `[`StopLoadingUseCase`](-stop-loading-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/SessionUseCases.kt#L180) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.session/-window-feature/-init-.md b/docs/api/mozilla.components.feature.session/-window-feature/-init-.md new file mode 100644 index 00000000000..a7ef50604d0 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-window-feature/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [WindowFeature](index.md) / [<init>](./-init-.md) + +# <init> + +`WindowFeature(engine: `[`Engine`](../../mozilla.components.concept.engine/-engine/index.md)`, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`)` + +Feature implementation for handling window requests. + diff --git a/docs/api/mozilla.components.feature.session/-window-feature/index.md b/docs/api/mozilla.components.feature.session/-window-feature/index.md new file mode 100644 index 00000000000..97855ac2ca5 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-window-feature/index.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [WindowFeature](./index.md) + +# WindowFeature + +`class WindowFeature : `[`LifecycleAwareFeature`](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/WindowFeature.kt#L17) + +Feature implementation for handling window requests. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `WindowFeature(engine: `[`Engine`](../../mozilla.components.concept.engine/-engine/index.md)`, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`)`
Feature implementation for handling window requests. | + +### Functions + +| Name | Summary | +|---|---| +| [start](start.md) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts the feature and a observer to listen for window requests. | +| [stop](stop.md) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stops the feature and the window request observer. | diff --git a/docs/api/mozilla.components.feature.session/-window-feature/start.md b/docs/api/mozilla.components.feature.session/-window-feature/start.md new file mode 100644 index 00000000000..1b4aa2d7616 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-window-feature/start.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [WindowFeature](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/WindowFeature.kt#L39) + +Overrides [LifecycleAwareFeature.start](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/start.md) + +Starts the feature and a observer to listen for window requests. + diff --git a/docs/api/mozilla.components.feature.session/-window-feature/stop.md b/docs/api/mozilla.components.feature.session/-window-feature/stop.md new file mode 100644 index 00000000000..f09e5a03b57 --- /dev/null +++ b/docs/api/mozilla.components.feature.session/-window-feature/stop.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.session](../index.md) / [WindowFeature](index.md) / [stop](./stop.md) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/session/src/main/java/mozilla/components/feature/session/WindowFeature.kt#L46) + +Overrides [LifecycleAwareFeature.stop](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/stop.md) + +Stops the feature and the window request observer. + diff --git a/docs/api/mozilla.components.feature.session/index.md b/docs/api/mozilla.components.feature.session/index.md new file mode 100644 index 00000000000..82796b2227d --- /dev/null +++ b/docs/api/mozilla.components.feature.session/index.md @@ -0,0 +1,15 @@ +[android-components](../index.md) / [mozilla.components.feature.session](./index.md) + +## Package mozilla.components.feature.session + +### Types + +| Name | Summary | +|---|---| +| [CoordinateScrollingFeature](-coordinate-scrolling-feature/index.md) | `class CoordinateScrollingFeature : `[`SelectionAwareSessionObserver`](../mozilla.components.browser.session/-selection-aware-session-observer/index.md)`, `[`LifecycleAwareFeature`](../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)
Feature implementation for connecting an [EngineView](../mozilla.components.concept.engine/-engine-view/index.md) with any View that you want to coordinate scrolling behavior with. | +| [EngineViewPresenter](-engine-view-presenter/index.md) | `class EngineViewPresenter : `[`Observer`](../mozilla.components.browser.session/-session-manager/-observer/index.md)
Presenter implementation for EngineView. | +| [FullScreenFeature](-full-screen-feature/index.md) | `open class FullScreenFeature : `[`SelectionAwareSessionObserver`](../mozilla.components.browser.session/-selection-aware-session-observer/index.md)`, `[`LifecycleAwareFeature`](../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)`, `[`BackHandler`](../mozilla.components.support.base.feature/-back-handler/index.md)
Feature implementation for handling fullscreen mode (exiting and back button presses). | +| [HistoryDelegate](-history-delegate/index.md) | `class HistoryDelegate : `[`HistoryTrackingDelegate`](../mozilla.components.concept.engine.history/-history-tracking-delegate/index.md)
Implementation of the [HistoryTrackingDelegate](../mozilla.components.concept.engine.history/-history-tracking-delegate/index.md) which delegates work to an instance of [HistoryStorage](../mozilla.components.concept.storage/-history-storage/index.md). | +| [SessionFeature](-session-feature/index.md) | `class SessionFeature : `[`LifecycleAwareFeature`](../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)`, `[`BackHandler`](../mozilla.components.support.base.feature/-back-handler/index.md)
Feature implementation for connecting the engine module with the session module. | +| [SessionUseCases](-session-use-cases/index.md) | `class SessionUseCases`
Contains use cases related to the session feature. | +| [WindowFeature](-window-feature/index.md) | `class WindowFeature : `[`LifecycleAwareFeature`](../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)
Feature implementation for handling window requests. | diff --git a/docs/api/mozilla.components.feature.sitepermissions/-on-need-to-request-permissions.md b/docs/api/mozilla.components.feature.sitepermissions/-on-need-to-request-permissions.md new file mode 100644 index 00000000000..3009e9d755c --- /dev/null +++ b/docs/api/mozilla.components.feature.sitepermissions/-on-need-to-request-permissions.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.feature.sitepermissions](index.md) / [OnNeedToRequestPermissions](./-on-need-to-request-permissions.md) + +# OnNeedToRequestPermissions + +`typealias OnNeedToRequestPermissions = (permissions: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sitepermissions/src/main/java/mozilla/components/feature/sitepermissions/SitePermissionsFeature.kt#L15) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/-init-.md b/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/-init-.md new file mode 100644 index 00000000000..d65e78eeb1a --- /dev/null +++ b/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/-init-.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.feature.sitepermissions](../index.md) / [SitePermissionsFeature](index.md) / [<init>](./-init-.md) + +# <init> + +`SitePermissionsFeature(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, onNeedToRequestPermissions: `[`OnNeedToRequestPermissions`](../-on-need-to-request-permissions.md)`)` + +This feature will subscribe to the currently selected [Session](../../mozilla.components.browser.session/-session/index.md) and display +a suitable dialogs based on [Session.Observer.onAppPermissionRequested](../../mozilla.components.browser.session/-session/-observer/on-app-permission-requested.md) or +[Session.Observer.onContentPermissionRequested](../../mozilla.components.browser.session/-session/-observer/on-content-permission-requested.md) events. +Once the dialog is closed the [PermissionRequest](../../mozilla.components.concept.engine.permission/-permission-request/index.md) will be consumed. + diff --git a/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/index.md b/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/index.md new file mode 100644 index 00000000000..2055da653ea --- /dev/null +++ b/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/index.md @@ -0,0 +1,26 @@ +[android-components](../../index.md) / [mozilla.components.feature.sitepermissions](../index.md) / [SitePermissionsFeature](./index.md) + +# SitePermissionsFeature + +`class SitePermissionsFeature : `[`LifecycleAwareFeature`](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sitepermissions/src/main/java/mozilla/components/feature/sitepermissions/SitePermissionsFeature.kt#L30) + +This feature will subscribe to the currently selected [Session](../../mozilla.components.browser.session/-session/index.md) and display +a suitable dialogs based on [Session.Observer.onAppPermissionRequested](../../mozilla.components.browser.session/-session/-observer/on-app-permission-requested.md) or +[Session.Observer.onContentPermissionRequested](../../mozilla.components.browser.session/-session/-observer/on-content-permission-requested.md) events. +Once the dialog is closed the [PermissionRequest](../../mozilla.components.concept.engine.permission/-permission-request/index.md) will be consumed. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SitePermissionsFeature(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, onNeedToRequestPermissions: `[`OnNeedToRequestPermissions`](../-on-need-to-request-permissions.md)`)`
This feature will subscribe to the currently selected [Session](../../mozilla.components.browser.session/-session/index.md) and display a suitable dialogs based on [Session.Observer.onAppPermissionRequested](../../mozilla.components.browser.session/-session/-observer/on-app-permission-requested.md) or [Session.Observer.onContentPermissionRequested](../../mozilla.components.browser.session/-session/-observer/on-content-permission-requested.md) events. Once the dialog is closed the [PermissionRequest](../../mozilla.components.concept.engine.permission/-permission-request/index.md) will be consumed. | + +### Functions + +| Name | Summary | +|---|---| +| [onContentPermissionDeny](on-content-permission-deny.md) | `fun onContentPermissionDeny(sessionId: `[`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)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Notifies that the permissions requested by this [sessionId](on-content-permission-deny.md#mozilla.components.feature.sitepermissions.SitePermissionsFeature$onContentPermissionDeny(kotlin.String, kotlin.String)/sessionId) were rejected. | +| [onContentPermissionGranted](on-content-permission-granted.md) | `fun onContentPermissionGranted(sessionId: `[`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)`, permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../../mozilla.components.concept.engine.permission/-permission/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Notifies that the list of [permissions](on-content-permission-granted.md#mozilla.components.feature.sitepermissions.SitePermissionsFeature$onContentPermissionGranted(kotlin.String, kotlin.String, kotlin.collections.List((mozilla.components.concept.engine.permission.Permission)))/permissions) have been granted for the [sessionId](on-content-permission-granted.md#mozilla.components.feature.sitepermissions.SitePermissionsFeature$onContentPermissionGranted(kotlin.String, kotlin.String, kotlin.collections.List((mozilla.components.concept.engine.permission.Permission)))/sessionId) and [url](on-content-permission-granted.md#mozilla.components.feature.sitepermissions.SitePermissionsFeature$onContentPermissionGranted(kotlin.String, kotlin.String, kotlin.collections.List((mozilla.components.concept.engine.permission.Permission)))/url). | +| [onPermissionsResult](on-permissions-result.md) | `fun onPermissionsResult(grantResults: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Notifies the feature that the permissions requested were completed. | +| [start](start.md) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [stop](stop.md) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/on-content-permission-deny.md b/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/on-content-permission-deny.md new file mode 100644 index 00000000000..8887cafddec --- /dev/null +++ b/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/on-content-permission-deny.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.feature.sitepermissions](../index.md) / [SitePermissionsFeature](index.md) / [onContentPermissionDeny](./on-content-permission-deny.md) + +# onContentPermissionDeny + +`fun onContentPermissionDeny(sessionId: `[`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)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sitepermissions/src/main/java/mozilla/components/feature/sitepermissions/SitePermissionsFeature.kt#L92) + +Notifies that the permissions requested by this [sessionId](on-content-permission-deny.md#mozilla.components.feature.sitepermissions.SitePermissionsFeature$onContentPermissionDeny(kotlin.String, kotlin.String)/sessionId) were rejected. + +### Parameters + +`sessionId` - this is the id of the session which requested the permissions. + +`url` - the url which requested the permissions. \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/on-content-permission-granted.md b/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/on-content-permission-granted.md new file mode 100644 index 00000000000..bbb48bda6b1 --- /dev/null +++ b/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/on-content-permission-granted.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.feature.sitepermissions](../index.md) / [SitePermissionsFeature](index.md) / [onContentPermissionGranted](./on-content-permission-granted.md) + +# onContentPermissionGranted + +`fun onContentPermissionGranted(sessionId: `[`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)`, permissions: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Permission`](../../mozilla.components.concept.engine.permission/-permission/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sitepermissions/src/main/java/mozilla/components/feature/sitepermissions/SitePermissionsFeature.kt#L76) + +Notifies that the list of [permissions](on-content-permission-granted.md#mozilla.components.feature.sitepermissions.SitePermissionsFeature$onContentPermissionGranted(kotlin.String, kotlin.String, kotlin.collections.List((mozilla.components.concept.engine.permission.Permission)))/permissions) have been granted for the [sessionId](on-content-permission-granted.md#mozilla.components.feature.sitepermissions.SitePermissionsFeature$onContentPermissionGranted(kotlin.String, kotlin.String, kotlin.collections.List((mozilla.components.concept.engine.permission.Permission)))/sessionId) and [url](on-content-permission-granted.md#mozilla.components.feature.sitepermissions.SitePermissionsFeature$onContentPermissionGranted(kotlin.String, kotlin.String, kotlin.collections.List((mozilla.components.concept.engine.permission.Permission)))/url). + +### Parameters + +`sessionId` - this is the id of the session which requested the permissions. + +`url` - the url which requested the permissions. + +`permissions` - the list of [permissions](on-content-permission-granted.md#mozilla.components.feature.sitepermissions.SitePermissionsFeature$onContentPermissionGranted(kotlin.String, kotlin.String, kotlin.collections.List((mozilla.components.concept.engine.permission.Permission)))/permissions) that have been granted. \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/on-permissions-result.md b/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/on-permissions-result.md new file mode 100644 index 00000000000..8c4398aa360 --- /dev/null +++ b/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/on-permissions-result.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.feature.sitepermissions](../index.md) / [SitePermissionsFeature](index.md) / [onPermissionsResult](./on-permissions-result.md) + +# onPermissionsResult + +`fun onPermissionsResult(grantResults: `[`IntArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sitepermissions/src/main/java/mozilla/components/feature/sitepermissions/SitePermissionsFeature.kt#L51) + +Notifies the feature that the permissions requested were completed. + +### Parameters + +`grantResults` - the grant results for the corresponding permissions + +**See Also** + +[onNeedToRequestPermissions](#) + diff --git a/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/start.md b/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/start.md new file mode 100644 index 00000000000..bd7689e80ee --- /dev/null +++ b/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/start.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.sitepermissions](../index.md) / [SitePermissionsFeature](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sitepermissions/src/main/java/mozilla/components/feature/sitepermissions/SitePermissionsFeature.kt#L37) + +Overrides [LifecycleAwareFeature.start](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/start.md) + diff --git a/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/stop.md b/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/stop.md new file mode 100644 index 00000000000..c2f84949c8d --- /dev/null +++ b/docs/api/mozilla.components.feature.sitepermissions/-site-permissions-feature/stop.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.sitepermissions](../index.md) / [SitePermissionsFeature](index.md) / [stop](./stop.md) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sitepermissions/src/main/java/mozilla/components/feature/sitepermissions/SitePermissionsFeature.kt#L41) + +Overrides [LifecycleAwareFeature.stop](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/stop.md) + diff --git a/docs/api/mozilla.components.feature.sitepermissions/index.md b/docs/api/mozilla.components.feature.sitepermissions/index.md new file mode 100644 index 00000000000..63af85a527b --- /dev/null +++ b/docs/api/mozilla.components.feature.sitepermissions/index.md @@ -0,0 +1,15 @@ +[android-components](../index.md) / [mozilla.components.feature.sitepermissions](./index.md) + +## Package mozilla.components.feature.sitepermissions + +### Types + +| Name | Summary | +|---|---| +| [SitePermissionsFeature](-site-permissions-feature/index.md) | `class SitePermissionsFeature : `[`LifecycleAwareFeature`](../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)
This feature will subscribe to the currently selected [Session](../mozilla.components.browser.session/-session/index.md) and display a suitable dialogs based on [Session.Observer.onAppPermissionRequested](../mozilla.components.browser.session/-session/-observer/on-app-permission-requested.md) or [Session.Observer.onContentPermissionRequested](../mozilla.components.browser.session/-session/-observer/on-content-permission-requested.md) events. Once the dialog is closed the [PermissionRequest](../mozilla.components.concept.engine.permission/-permission-request/index.md) will be consumed. | + +### Type Aliases + +| Name | Summary | +|---|---| +| [OnNeedToRequestPermissions](-on-need-to-request-permissions.md) | `typealias OnNeedToRequestPermissions = (permissions: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/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) | diff --git a/docs/api/mozilla.components.feature.sync/-auth-exception-type/-k-e-y_-i-n-f-o.md b/docs/api/mozilla.components.feature.sync/-auth-exception-type/-k-e-y_-i-n-f-o.md new file mode 100644 index 00000000000..c1bb072aaac --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-auth-exception-type/-k-e-y_-i-n-f-o.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [AuthExceptionType](index.md) / [KEY_INFO](./-k-e-y_-i-n-f-o.md) + +# KEY_INFO + +`KEY_INFO` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/Types.kt#L16) + +### Inherited Properties + +| Name | Summary | +|---|---| +| [msg](msg.md) | `val msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.feature.sync/-auth-exception-type/index.md b/docs/api/mozilla.components.feature.sync/-auth-exception-type/index.md new file mode 100644 index 00000000000..2d724f2f0da --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-auth-exception-type/index.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [AuthExceptionType](./index.md) + +# AuthExceptionType + +`enum class AuthExceptionType` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/Types.kt#L15) + +An auth-related exception type, for use with [AuthException](../-auth-exception/index.md). + +### Enum Values + +| Name | Summary | +|---|---| +| [KEY_INFO](-k-e-y_-i-n-f-o.md) | | + +### Properties + +| Name | Summary | +|---|---| +| [msg](msg.md) | `val msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.feature.sync/-auth-exception-type/msg.md b/docs/api/mozilla.components.feature.sync/-auth-exception-type/msg.md new file mode 100644 index 00000000000..5e514cec484 --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-auth-exception-type/msg.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [AuthExceptionType](index.md) / [msg](./msg.md) + +# msg + +`val msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/Types.kt#L15) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.sync/-auth-exception/-init-.md b/docs/api/mozilla.components.feature.sync/-auth-exception/-init-.md new file mode 100644 index 00000000000..d0d9f7b59ca --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-auth-exception/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [AuthException](index.md) / [<init>](./-init-.md) + +# <init> + +`AuthException(type: `[`AuthExceptionType`](../-auth-exception-type/index.md)`)` + +An exception which may happen while obtaining auth information using [FirefoxAccount](../../mozilla.components.service.fxa/-firefox-account/index.md). + diff --git a/docs/api/mozilla.components.feature.sync/-auth-exception/index.md b/docs/api/mozilla.components.feature.sync/-auth-exception/index.md new file mode 100644 index 00000000000..d58a1106633 --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-auth-exception/index.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [AuthException](./index.md) + +# AuthException + +`class AuthException : `[`Exception`](https://developer.android.com/reference/java/lang/Exception.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/Types.kt#L22) + +An exception which may happen while obtaining auth information using [FirefoxAccount](../../mozilla.components.service.fxa/-firefox-account/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AuthException(type: `[`AuthExceptionType`](../-auth-exception-type/index.md)`)`
An exception which may happen while obtaining auth information using [FirefoxAccount](../../mozilla.components.service.fxa/-firefox-account/index.md). | diff --git a/docs/api/mozilla.components.feature.sync/-firefox-sync-feature/-init-.md b/docs/api/mozilla.components.feature.sync/-firefox-sync-feature/-init-.md new file mode 100644 index 00000000000..4745e9a36cb --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-firefox-sync-feature/-init-.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [FirefoxSyncFeature](index.md) / [<init>](./-init-.md) + +# <init> + +`FirefoxSyncFeature(syncableStores: `[`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)`, `[`SyncableStore`](../../mozilla.components.concept.storage/-syncable-store/index.md)`<`[`AuthType`](index.md#AuthType)`>>, reifyAuth: suspend (authInfo: `[`FxaAuthInfo`](../-fxa-auth-info/index.md)`) -> `[`AuthType`](index.md#AuthType)`)` + +A feature implementation which orchestrates data synchronization of a set of [SyncableStore](../../mozilla.components.concept.storage/-syncable-store/index.md) which +all share a common [AuthType](index.md#AuthType). + +[AuthType](index.md#AuthType) provides us with a layer of indirection that allows consumers of [FirefoxSyncFeature](index.md) +to use entirely different types of [SyncableStore](../../mozilla.components.concept.storage/-syncable-store/index.md), without this feature needing to depend on +their specific implementations. Those implementations might have heavy native dependencies +(e.g. places and logins depend on native libraries), and we do not want to force a consumer which +only cares about syncing logins to have to import a places native library. + +### Parameters + +`reifyAuth` - A conversion method which reifies a generic [FxaAuthInfo](../-fxa-auth-info/index.md) into an object of +type [AuthType](index.md#AuthType). \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.sync/-firefox-sync-feature/index.md b/docs/api/mozilla.components.feature.sync/-firefox-sync-feature/index.md new file mode 100644 index 00000000000..8d724291ea2 --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-firefox-sync-feature/index.md @@ -0,0 +1,32 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [FirefoxSyncFeature](./index.md) + +# FirefoxSyncFeature + +`class FirefoxSyncFeature : `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`SyncStatusObserver`](../-sync-status-observer/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/FirefoxSyncFeature.kt#L53) + +A feature implementation which orchestrates data synchronization of a set of [SyncableStore](../../mozilla.components.concept.storage/-syncable-store/index.md) which +all share a common [AuthType](index.md#AuthType). + +[AuthType](index.md#AuthType) provides us with a layer of indirection that allows consumers of [FirefoxSyncFeature](./index.md) +to use entirely different types of [SyncableStore](../../mozilla.components.concept.storage/-syncable-store/index.md), without this feature needing to depend on +their specific implementations. Those implementations might have heavy native dependencies +(e.g. places and logins depend on native libraries), and we do not want to force a consumer which +only cares about syncing logins to have to import a places native library. + +### Parameters + +`reifyAuth` - A conversion method which reifies a generic [FxaAuthInfo](../-fxa-auth-info/index.md) into an object of +type [AuthType](index.md#AuthType). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FirefoxSyncFeature(syncableStores: `[`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)`, `[`SyncableStore`](../../mozilla.components.concept.storage/-syncable-store/index.md)`<`[`AuthType`](index.md#AuthType)`>>, reifyAuth: suspend (authInfo: `[`FxaAuthInfo`](../-fxa-auth-info/index.md)`) -> `[`AuthType`](index.md#AuthType)`)`
A feature implementation which orchestrates data synchronization of a set of [SyncableStore](../../mozilla.components.concept.storage/-syncable-store/index.md) which all share a common [AuthType](index.md#AuthType). | + +### Functions + +| Name | Summary | +|---|---| +| [sync](sync.md) | `suspend fun sync(account: `[`FirefoxAccountShaped`](../../mozilla.components.service.fxa/-firefox-account-shaped/index.md)`): `[`SyncResult`](../-sync-result.md)
Performs a sync of configured [SyncableStore](../../mozilla.components.concept.storage/-syncable-store/index.md) history instance. This method guarantees that only one sync may be running at any given time. | +| [syncRunning](sync-running.md) | `fun syncRunning(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | diff --git a/docs/api/mozilla.components.feature.sync/-firefox-sync-feature/sync-running.md b/docs/api/mozilla.components.feature.sync/-firefox-sync-feature/sync-running.md new file mode 100644 index 00000000000..74ebc8cc264 --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-firefox-sync-feature/sync-running.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [FirefoxSyncFeature](index.md) / [syncRunning](./sync-running.md) + +# syncRunning + +`fun syncRunning(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/FirefoxSyncFeature.kt#L68) + +**Return** +A [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) indicating if any sync operations are currently running. + diff --git a/docs/api/mozilla.components.feature.sync/-firefox-sync-feature/sync.md b/docs/api/mozilla.components.feature.sync/-firefox-sync-feature/sync.md new file mode 100644 index 00000000000..cc23290cbc5 --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-firefox-sync-feature/sync.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [FirefoxSyncFeature](index.md) / [sync](./sync.md) + +# sync + +`suspend fun sync(account: `[`FirefoxAccountShaped`](../../mozilla.components.service.fxa/-firefox-account-shaped/index.md)`): `[`SyncResult`](../-sync-result.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/FirefoxSyncFeature.kt#L79) + +Performs a sync of configured [SyncableStore](../../mozilla.components.concept.storage/-syncable-store/index.md) history instance. This method guarantees that +only one sync may be running at any given time. + +### Parameters + +`account` - [FirefoxAccountShaped](../../mozilla.components.service.fxa/-firefox-account-shaped/index.md) for which to perform a sync. + +**Return** +a [SyncResult](../-sync-result.md) indicating result of synchronization of configured stores. + diff --git a/docs/api/mozilla.components.feature.sync/-fxa-auth-info/-init-.md b/docs/api/mozilla.components.feature.sync/-fxa-auth-info/-init-.md new file mode 100644 index 00000000000..385ae10234e --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-fxa-auth-info/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [FxaAuthInfo](index.md) / [<init>](./-init-.md) + +# <init> + +`FxaAuthInfo(kid: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, fxaAccessToken: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, syncKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, tokenServerUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +A Firefox Sync friendly auth object which can be obtained from [FirefoxAccount](../../mozilla.components.service.fxa/-firefox-account/index.md). + diff --git a/docs/api/mozilla.components.feature.sync/-fxa-auth-info/fxa-access-token.md b/docs/api/mozilla.components.feature.sync/-fxa-auth-info/fxa-access-token.md new file mode 100644 index 00000000000..ec4f0813914 --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-fxa-auth-info/fxa-access-token.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [FxaAuthInfo](index.md) / [fxaAccessToken](./fxa-access-token.md) + +# fxaAccessToken + +`val fxaAccessToken: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/Types.kt#L35) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.sync/-fxa-auth-info/index.md b/docs/api/mozilla.components.feature.sync/-fxa-auth-info/index.md new file mode 100644 index 00000000000..ad108d2e02f --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-fxa-auth-info/index.md @@ -0,0 +1,22 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [FxaAuthInfo](./index.md) + +# FxaAuthInfo + +`data class FxaAuthInfo` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/Types.kt#L33) + +A Firefox Sync friendly auth object which can be obtained from [FirefoxAccount](../../mozilla.components.service.fxa/-firefox-account/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FxaAuthInfo(kid: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, fxaAccessToken: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, syncKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, tokenServerUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
A Firefox Sync friendly auth object which can be obtained from [FirefoxAccount](../../mozilla.components.service.fxa/-firefox-account/index.md). | + +### Properties + +| Name | Summary | +|---|---| +| [fxaAccessToken](fxa-access-token.md) | `val fxaAccessToken: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [kid](kid.md) | `val kid: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [syncKey](sync-key.md) | `val syncKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [tokenServerUrl](token-server-url.md) | `val tokenServerUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.feature.sync/-fxa-auth-info/kid.md b/docs/api/mozilla.components.feature.sync/-fxa-auth-info/kid.md new file mode 100644 index 00000000000..6b2fe31d0eb --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-fxa-auth-info/kid.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [FxaAuthInfo](index.md) / [kid](./kid.md) + +# kid + +`val kid: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/Types.kt#L34) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.sync/-fxa-auth-info/sync-key.md b/docs/api/mozilla.components.feature.sync/-fxa-auth-info/sync-key.md new file mode 100644 index 00000000000..24f899a11d2 --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-fxa-auth-info/sync-key.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [FxaAuthInfo](index.md) / [syncKey](./sync-key.md) + +# syncKey + +`val syncKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/Types.kt#L36) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.sync/-fxa-auth-info/token-server-url.md b/docs/api/mozilla.components.feature.sync/-fxa-auth-info/token-server-url.md new file mode 100644 index 00000000000..1c56e891590 --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-fxa-auth-info/token-server-url.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [FxaAuthInfo](index.md) / [tokenServerUrl](./token-server-url.md) + +# tokenServerUrl + +`val tokenServerUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/Types.kt#L37) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.sync/-store-sync-status/-init-.md b/docs/api/mozilla.components.feature.sync/-store-sync-status/-init-.md new file mode 100644 index 00000000000..17a100d5479 --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-store-sync-status/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [StoreSyncStatus](index.md) / [<init>](./-init-.md) + +# <init> + +`StoreSyncStatus(status: `[`SyncStatus`](../../mozilla.components.concept.storage/-sync-status.md)`)` \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.sync/-store-sync-status/index.md b/docs/api/mozilla.components.feature.sync/-store-sync-status/index.md new file mode 100644 index 00000000000..ada67d4a6da --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-store-sync-status/index.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [StoreSyncStatus](./index.md) + +# StoreSyncStatus + +`data class StoreSyncStatus` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/Types.kt#L28) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `StoreSyncStatus(status: `[`SyncStatus`](../../mozilla.components.concept.storage/-sync-status.md)`)` | + +### Properties + +| Name | Summary | +|---|---| +| [status](status.md) | `val status: `[`SyncStatus`](../../mozilla.components.concept.storage/-sync-status.md) | diff --git a/docs/api/mozilla.components.feature.sync/-store-sync-status/status.md b/docs/api/mozilla.components.feature.sync/-store-sync-status/status.md new file mode 100644 index 00000000000..e1fc9033ab2 --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-store-sync-status/status.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [StoreSyncStatus](index.md) / [status](./status.md) + +# status + +`val status: `[`SyncStatus`](../../mozilla.components.concept.storage/-sync-status.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/Types.kt#L28) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.sync/-sync-result.md b/docs/api/mozilla.components.feature.sync/-sync-result.md new file mode 100644 index 00000000000..6dccfdf9b95 --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-sync-result.md @@ -0,0 +1,8 @@ +[android-components](../index.md) / [mozilla.components.feature.sync](index.md) / [SyncResult](./-sync-result.md) + +# SyncResult + +`typealias SyncResult = `[`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)`, `[`StoreSyncStatus`](-store-sync-status/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/Types.kt#L27) + +A set of results of running a sync operation for all configured stores. + diff --git a/docs/api/mozilla.components.feature.sync/-sync-status-observer/index.md b/docs/api/mozilla.components.feature.sync/-sync-status-observer/index.md new file mode 100644 index 00000000000..ce26c78dd97 --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-sync-status-observer/index.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [SyncStatusObserver](./index.md) + +# SyncStatusObserver + +`interface SyncStatusObserver` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/FirefoxSyncFeature.kt#L20) + +An interface for consumers that wish to observer "sync lifecycle" events. + +### Functions + +| Name | Summary | +|---|---| +| [onError](on-error.md) | `abstract fun onError(error: `[`Exception`](https://developer.android.com/reference/java/lang/Exception.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Gets called if sync encounters an error that's worthy of processing by status observers. | +| [onIdle](on-idle.md) | `abstract fun onIdle(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Gets called at the end of a sync, after every configured syncable has been synchronized. | +| [onStarted](on-started.md) | `abstract fun onStarted(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Gets called at the start of a sync, before any configured syncable is synchronized. | diff --git a/docs/api/mozilla.components.feature.sync/-sync-status-observer/on-error.md b/docs/api/mozilla.components.feature.sync/-sync-status-observer/on-error.md new file mode 100644 index 00000000000..0ed48278e73 --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-sync-status-observer/on-error.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [SyncStatusObserver](index.md) / [onError](./on-error.md) + +# onError + +`abstract fun onError(error: `[`Exception`](https://developer.android.com/reference/java/lang/Exception.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/FirefoxSyncFeature.kt#L35) + +Gets called if sync encounters an error that's worthy of processing by status observers. + +### Parameters + +`error` - Optional relevant exception. \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.sync/-sync-status-observer/on-idle.md b/docs/api/mozilla.components.feature.sync/-sync-status-observer/on-idle.md new file mode 100644 index 00000000000..1946ba73bc1 --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-sync-status-observer/on-idle.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [SyncStatusObserver](index.md) / [onIdle](./on-idle.md) + +# onIdle + +`abstract fun onIdle(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/FirefoxSyncFeature.kt#L29) + +Gets called at the end of a sync, after every configured syncable has been synchronized. + diff --git a/docs/api/mozilla.components.feature.sync/-sync-status-observer/on-started.md b/docs/api/mozilla.components.feature.sync/-sync-status-observer/on-started.md new file mode 100644 index 00000000000..cef10322d4c --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/-sync-status-observer/on-started.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.sync](../index.md) / [SyncStatusObserver](index.md) / [onStarted](./on-started.md) + +# onStarted + +`abstract fun onStarted(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/FirefoxSyncFeature.kt#L24) + +Gets called at the start of a sync, before any configured syncable is synchronized. + diff --git a/docs/api/mozilla.components.feature.sync/index.md b/docs/api/mozilla.components.feature.sync/index.md new file mode 100644 index 00000000000..27277dfc755 --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/index.md @@ -0,0 +1,31 @@ +[android-components](../index.md) / [mozilla.components.feature.sync](./index.md) + +## Package mozilla.components.feature.sync + +### Types + +| Name | Summary | +|---|---| +| [AuthExceptionType](-auth-exception-type/index.md) | `enum class AuthExceptionType`
An auth-related exception type, for use with [AuthException](-auth-exception/index.md). | +| [FirefoxSyncFeature](-firefox-sync-feature/index.md) | `class FirefoxSyncFeature : `[`Observable`](../mozilla.components.support.base.observer/-observable/index.md)`<`[`SyncStatusObserver`](-sync-status-observer/index.md)`>`
A feature implementation which orchestrates data synchronization of a set of [SyncableStore](../mozilla.components.concept.storage/-syncable-store/index.md) which all share a common [AuthType](-firefox-sync-feature/index.md#AuthType). | +| [FxaAuthInfo](-fxa-auth-info/index.md) | `data class FxaAuthInfo`
A Firefox Sync friendly auth object which can be obtained from [FirefoxAccount](../mozilla.components.service.fxa/-firefox-account/index.md). | +| [StoreSyncStatus](-store-sync-status/index.md) | `data class StoreSyncStatus` | +| [SyncStatusObserver](-sync-status-observer/index.md) | `interface SyncStatusObserver`
An interface for consumers that wish to observer "sync lifecycle" events. | + +### Exceptions + +| Name | Summary | +|---|---| +| [AuthException](-auth-exception/index.md) | `class AuthException : `[`Exception`](https://developer.android.com/reference/java/lang/Exception.html)
An exception which may happen while obtaining auth information using [FirefoxAccount](../mozilla.components.service.fxa/-firefox-account/index.md). | + +### Type Aliases + +| Name | Summary | +|---|---| +| [SyncResult](-sync-result.md) | `typealias SyncResult = `[`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)`, `[`StoreSyncStatus`](-store-sync-status/index.md)`>`
A set of results of running a sync operation for all configured stores. | + +### Properties + +| Name | Summary | +|---|---| +| [registry](registry.md) | `val registry: `[`ObserverRegistry`](../mozilla.components.support.base.observer/-observer-registry/index.md)`<`[`SyncStatusObserver`](-sync-status-observer/index.md)`>` | diff --git a/docs/api/mozilla.components.feature.sync/registry.md b/docs/api/mozilla.components.feature.sync/registry.md new file mode 100644 index 00000000000..8f50c154e5e --- /dev/null +++ b/docs/api/mozilla.components.feature.sync/registry.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.feature.sync](index.md) / [registry](./registry.md) + +# registry + +`val registry: `[`ObserverRegistry`](../mozilla.components.support.base.observer/-observer-registry/index.md)`<`[`SyncStatusObserver`](-sync-status-observer/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/sync/src/main/java/mozilla/components/feature/sync/FirefoxSyncFeature.kt#L38) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/-init-.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/-init-.md new file mode 100644 index 00000000000..6d6c64c0049 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsFeature](index.md) / [<init>](./-init-.md) + +# <init> + +`TabsFeature(tabsTray: `[`TabsTray`](../../mozilla.components.concept.tabstray/-tabs-tray/index.md)`, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, tabsUseCases: `[`TabsUseCases`](../../mozilla.components.feature.tabs/-tabs-use-cases/index.md)`, closeTabsTray: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +Feature implementation for connecting a tabs tray implementation with the session module. + diff --git a/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/filter-tabs.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/filter-tabs.md new file mode 100644 index 00000000000..cbcdd88e6ee --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/filter-tabs.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsFeature](index.md) / [filterTabs](./filter-tabs.md) + +# filterTabs + +`fun filterTabs(tabsFilter: (`[`Session`](../../mozilla.components.browser.session/-session/index.md)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/tabstray/TabsFeature.kt#L47) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/index.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/index.md new file mode 100644 index 00000000000..7e52a244105 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/index.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsFeature](./index.md) + +# TabsFeature + +`class TabsFeature : `[`LifecycleAwareFeature`](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/tabstray/TabsFeature.kt#L17) + +Feature implementation for connecting a tabs tray implementation with the session module. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TabsFeature(tabsTray: `[`TabsTray`](../../mozilla.components.concept.tabstray/-tabs-tray/index.md)`, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, tabsUseCases: `[`TabsUseCases`](../../mozilla.components.feature.tabs/-tabs-use-cases/index.md)`, closeTabsTray: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
Feature implementation for connecting a tabs tray implementation with the session module. | + +### Functions + +| Name | Summary | +|---|---| +| [filterTabs](filter-tabs.md) | `fun filterTabs(tabsFilter: (`[`Session`](../../mozilla.components.browser.session/-session/index.md)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [start](start.md) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [stop](stop.md) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/start.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/start.md new file mode 100644 index 00000000000..1839bad0386 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/start.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsFeature](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/tabstray/TabsFeature.kt#L37) + +Overrides [LifecycleAwareFeature.start](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/start.md) + diff --git a/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/stop.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/stop.md new file mode 100644 index 00000000000..59222bde9a0 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-feature/stop.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsFeature](index.md) / [stop](./stop.md) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/tabstray/TabsFeature.kt#L42) + +Overrides [LifecycleAwareFeature.stop](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/stop.md) + diff --git a/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/-init-.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/-init-.md new file mode 100644 index 00000000000..3127665fdc3 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsTrayInteractor](index.md) / [<init>](./-init-.md) + +# <init> + +`TabsTrayInteractor(tabsTray: `[`TabsTray`](../../mozilla.components.concept.tabstray/-tabs-tray/index.md)`, selectTabUseCase: `[`SelectTabUseCase`](../../mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/index.md)`, removeTabUseCase: `[`RemoveTabUseCase`](../../mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/index.md)`, 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/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/index.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/index.md new file mode 100644 index 00000000000..189b872f18d --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsTrayInteractor](./index.md) + +# TabsTrayInteractor + +`class TabsTrayInteractor : `[`Observer`](../../mozilla.components.concept.tabstray/-tabs-tray/-observer/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/tabstray/TabsTrayInteractor.kt#L19) + +Interactor for a tabs tray component. Subscribes to the tabs tray and invokes use cases to update +the session manager. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TabsTrayInteractor(tabsTray: `[`TabsTray`](../../mozilla.components.concept.tabstray/-tabs-tray/index.md)`, selectTabUseCase: `[`SelectTabUseCase`](../../mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/index.md)`, removeTabUseCase: `[`RemoveTabUseCase`](../../mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/index.md)`, 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 + +| Name | Summary | +|---|---| +| [onTabClosed](on-tab-closed.md) | `fun onTabClosed(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
A tab has been closed. | +| [onTabSelected](on-tab-selected.md) | `fun onTabSelected(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
A new tab has been selected. | +| [start](start.md) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [stop](stop.md) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/on-tab-closed.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/on-tab-closed.md new file mode 100644 index 00000000000..9414a5ad811 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/on-tab-closed.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsTrayInteractor](index.md) / [onTabClosed](./on-tab-closed.md) + +# onTabClosed + +`fun onTabClosed(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/tabstray/TabsTrayInteractor.kt#L44) + +Overrides [Observer.onTabClosed](../../mozilla.components.concept.tabstray/-tabs-tray/-observer/on-tab-closed.md) + +A tab has been closed. + diff --git a/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/on-tab-selected.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/on-tab-selected.md new file mode 100644 index 00000000000..894f9d9091c --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/on-tab-selected.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsTrayInteractor](index.md) / [onTabSelected](./on-tab-selected.md) + +# onTabSelected + +`fun onTabSelected(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/tabstray/TabsTrayInteractor.kt#L34) + +Overrides [Observer.onTabSelected](../../mozilla.components.concept.tabstray/-tabs-tray/-observer/on-tab-selected.md) + +A new tab has been selected. + diff --git a/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/start.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/start.md new file mode 100644 index 00000000000..d480fb86b75 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/start.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsTrayInteractor](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/tabstray/TabsTrayInteractor.kt#L26) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/stop.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/stop.md new file mode 100644 index 00000000000..27a2292a103 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-interactor/stop.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsTrayInteractor](index.md) / [stop](./stop.md) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/tabstray/TabsTrayInteractor.kt#L30) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/-init-.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/-init-.md new file mode 100644 index 00000000000..8aa6a5c701b --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsTrayPresenter](index.md) / [<init>](./-init-.md) + +# <init> + +`TabsTrayPresenter(tabsTray: `[`TabsTray`](../../mozilla.components.concept.tabstray/-tabs-tray/index.md)`, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, closeTabsTray: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, sessionsFilter: (`[`Session`](../../mozilla.components.browser.session/-session/index.md)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = { true })` + +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/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/index.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/index.md new file mode 100644 index 00000000000..d666d8d3f82 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/index.md @@ -0,0 +1,31 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsTrayPresenter](./index.md) + +# TabsTrayPresenter + +`class TabsTrayPresenter : `[`Observer`](../../mozilla.components.browser.session/-session-manager/-observer/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/tabstray/TabsTrayPresenter.kt#L17) + +Presenter implementation for a tabs tray implementation in order to update the tabs tray whenever +the state of the session manager changes. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TabsTrayPresenter(tabsTray: `[`TabsTray`](../../mozilla.components.concept.tabstray/-tabs-tray/index.md)`, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, closeTabsTray: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`, sessionsFilter: (`[`Session`](../../mozilla.components.browser.session/-session/index.md)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = { true })`
Presenter implementation for a tabs tray implementation in order to update the tabs tray whenever the state of the session manager changes. | + +### Functions + +| Name | Summary | +|---|---| +| [onAllSessionsRemoved](on-all-sessions-removed.md) | `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.md) | `fun onSessionAdded(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
The given session has been added. | +| [onSessionRemoved](on-session-removed.md) | `fun onSessionRemoved(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
The given session has been removed. | +| [onSessionSelected](on-session-selected.md) | `fun onSessionSelected(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`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. | +| [start](start.md) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [stop](stop.md) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [onSessionsRestored](../../mozilla.components.browser.session/-session-manager/-observer/on-sessions-restored.md) | `open fun onSessionsRestored(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Sessions have been restored via a snapshot. This callback is invoked at the end of the call to read, after every session in the snapshot was added, and appropriate session was selected. | diff --git a/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-all-sessions-removed.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-all-sessions-removed.md new file mode 100644 index 00000000000..d386ef21e3c --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-all-sessions-removed.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsTrayPresenter](index.md) / [onAllSessionsRemoved](./on-all-sessions-removed.md) + +# onAllSessionsRemoved + +`fun onAllSessionsRemoved(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/tabstray/TabsTrayPresenter.kt#L52) + +Overrides [Observer.onAllSessionsRemoved](../../mozilla.components.browser.session/-session-manager/-observer/on-all-sessions-removed.md) + +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/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-added.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-added.md new file mode 100644 index 00000000000..67642e22fda --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-added.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsTrayPresenter](index.md) / [onSessionAdded](./on-session-added.md) + +# onSessionAdded + +`fun onSessionAdded(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/tabstray/TabsTrayPresenter.kt#L44) + +Overrides [Observer.onSessionAdded](../../mozilla.components.browser.session/-session-manager/-observer/on-session-added.md) + +The given session has been added. + diff --git a/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-removed.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-removed.md new file mode 100644 index 00000000000..0cfb2be63ca --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-removed.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsTrayPresenter](index.md) / [onSessionRemoved](./on-session-removed.md) + +# onSessionRemoved + +`fun onSessionRemoved(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/tabstray/TabsTrayPresenter.kt#L36) + +Overrides [Observer.onSessionRemoved](../../mozilla.components.browser.session/-session-manager/-observer/on-session-removed.md) + +The given session has been removed. + diff --git a/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-selected.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-selected.md new file mode 100644 index 00000000000..e66767a6b6d --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/on-session-selected.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsTrayPresenter](index.md) / [onSessionSelected](./on-session-selected.md) + +# onSessionSelected + +`fun onSessionSelected(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/tabstray/TabsTrayPresenter.kt#L48) + +Overrides [Observer.onSessionSelected](../../mozilla.components.browser.session/-session-manager/-observer/on-session-selected.md) + +The selection has changed and the given session is now the selected session. + diff --git a/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/start.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/start.md new file mode 100644 index 00000000000..0b7375d5945 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/start.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsTrayPresenter](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/tabstray/TabsTrayPresenter.kt#L26) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/stop.md b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/stop.md new file mode 100644 index 00000000000..cada65d3a7e --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/-tabs-tray-presenter/stop.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.tabstray](../index.md) / [TabsTrayPresenter](index.md) / [stop](./stop.md) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/tabstray/TabsTrayPresenter.kt#L32) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs.tabstray/index.md b/docs/api/mozilla.components.feature.tabs.tabstray/index.md new file mode 100644 index 00000000000..7e647af476b --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.tabstray/index.md @@ -0,0 +1,11 @@ +[android-components](../index.md) / [mozilla.components.feature.tabs.tabstray](./index.md) + +## Package mozilla.components.feature.tabs.tabstray + +### Types + +| Name | Summary | +|---|---| +| [TabsFeature](-tabs-feature/index.md) | `class TabsFeature : `[`LifecycleAwareFeature`](../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)
Feature implementation for connecting a tabs tray implementation with the session module. | +| [TabsTrayInteractor](-tabs-tray-interactor/index.md) | `class TabsTrayInteractor : `[`Observer`](../mozilla.components.concept.tabstray/-tabs-tray/-observer/index.md)
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.md) | `class TabsTrayPresenter : `[`Observer`](../mozilla.components.browser.session/-session-manager/-observer/index.md)
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/mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/-init-.md b/docs/api/mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/-init-.md new file mode 100644 index 00000000000..a9ebe5ebca9 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.toolbar](../index.md) / [TabCounterToolbarButton](index.md) / [<init>](./-init-.md) + +# <init> + +`TabCounterToolbarButton(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, showTabs: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` + +A [Toolbar.Action](../../mozilla.components.concept.toolbar/-toolbar/-action/index.md) implementation that shows a [TabCounter](../../mozilla.components.ui.tabcounter/-tab-counter/index.md). + diff --git a/docs/api/mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/bind.md b/docs/api/mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/bind.md new file mode 100644 index 00000000000..90b56d241f7 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/bind.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.toolbar](../index.md) / [TabCounterToolbarButton](index.md) / [bind](./bind.md) + +# bind + +`fun bind(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/toolbar/TabCounterToolbarButton.kt#L47) + +Overrides [Action.bind](../../mozilla.components.concept.toolbar/-toolbar/-action/bind.md) + diff --git a/docs/api/mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/create-view.md b/docs/api/mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/create-view.md new file mode 100644 index 00000000000..b418048b7e2 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/create-view.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.toolbar](../index.md) / [TabCounterToolbarButton](index.md) / [createView](./create-view.md) + +# createView + +`fun createView(parent: `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`): `[`View`](https://developer.android.com/reference/android/view/View.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/toolbar/TabCounterToolbarButton.kt#L27) + +Overrides [Action.createView](../../mozilla.components.concept.toolbar/-toolbar/-action/create-view.md) + diff --git a/docs/api/mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/index.md b/docs/api/mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/index.md new file mode 100644 index 00000000000..f20db6b1375 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.toolbar/-tab-counter-toolbar-button/index.md @@ -0,0 +1,26 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.toolbar](../index.md) / [TabCounterToolbarButton](./index.md) + +# TabCounterToolbarButton + +`class TabCounterToolbarButton : `[`Action`](../../mozilla.components.concept.toolbar/-toolbar/-action/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/toolbar/TabCounterToolbarButton.kt#L21) + +A [Toolbar.Action](../../mozilla.components.concept.toolbar/-toolbar/-action/index.md) implementation that shows a [TabCounter](../../mozilla.components.ui.tabcounter/-tab-counter/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TabCounterToolbarButton(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, showTabs: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
A [Toolbar.Action](../../mozilla.components.concept.toolbar/-toolbar/-action/index.md) implementation that shows a [TabCounter](../../mozilla.components.ui.tabcounter/-tab-counter/index.md). | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [visible](../../mozilla.components.concept.toolbar/-toolbar/-action/visible.md) | `open val visible: () -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [bind](bind.md) | `fun bind(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [createView](create-view.md) | `fun createView(parent: `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`): `[`View`](https://developer.android.com/reference/android/view/View.html) | diff --git a/docs/api/mozilla.components.feature.tabs.toolbar/-tabs-toolbar-feature/-init-.md b/docs/api/mozilla.components.feature.tabs.toolbar/-tabs-toolbar-feature/-init-.md new file mode 100644 index 00000000000..de2f226d7b3 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.toolbar/-tabs-toolbar-feature/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.toolbar](../index.md) / [TabsToolbarFeature](index.md) / [<init>](./-init-.md) + +# <init> + +`TabsToolbarFeature(toolbar: `[`Toolbar`](../../mozilla.components.concept.toolbar/-toolbar/index.md)`, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, 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/mozilla.components.feature.tabs.toolbar/-tabs-toolbar-feature/index.md b/docs/api/mozilla.components.feature.tabs.toolbar/-tabs-toolbar-feature/index.md new file mode 100644 index 00000000000..873f57967c3 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.toolbar/-tabs-toolbar-feature/index.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs.toolbar](../index.md) / [TabsToolbarFeature](./index.md) + +# TabsToolbarFeature + +`class TabsToolbarFeature` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/toolbar/TabsToolbarFeature.kt#L15) + +Feature implementation for connecting a tabs tray implementation with a toolbar implementation. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TabsToolbarFeature(toolbar: `[`Toolbar`](../../mozilla.components.concept.toolbar/-toolbar/index.md)`, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, sessionId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, 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/mozilla.components.feature.tabs.toolbar/index.md b/docs/api/mozilla.components.feature.tabs.toolbar/index.md new file mode 100644 index 00000000000..3b73fe49f6c --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs.toolbar/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.feature.tabs.toolbar](./index.md) + +## Package mozilla.components.feature.tabs.toolbar + +### Types + +| Name | Summary | +|---|---| +| [TabCounterToolbarButton](-tab-counter-toolbar-button/index.md) | `class TabCounterToolbarButton : `[`Action`](../mozilla.components.concept.toolbar/-toolbar/-action/index.md)
A [Toolbar.Action](../mozilla.components.concept.toolbar/-toolbar/-action/index.md) implementation that shows a [TabCounter](../mozilla.components.ui.tabcounter/-tab-counter/index.md). | +| [TabsToolbarFeature](-tabs-toolbar-feature/index.md) | `class TabsToolbarFeature`
Feature implementation for connecting a tabs tray implementation with a toolbar implementation. | diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-private-tab-use-case/index.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-private-tab-use-case/index.md new file mode 100644 index 00000000000..4268dda2567 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-private-tab-use-case/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.tabs](../../index.md) / [TabsUseCases](../index.md) / [AddNewPrivateTabUseCase](./index.md) + +# AddNewPrivateTabUseCase + +`class AddNewPrivateTabUseCase : `[`LoadUrlUseCase`](../../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L82) + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `fun invoke(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)
`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, startLoading: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, parent: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = null): `[`Session`](../../../mozilla.components.browser.session/-session/index.md)
Adds a new private tab and loads the provided URL. | diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-private-tab-use-case/invoke.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-private-tab-use-case/invoke.md new file mode 100644 index 00000000000..a802731130a --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-private-tab-use-case/invoke.md @@ -0,0 +1,25 @@ +[android-components](../../../index.md) / [mozilla.components.feature.tabs](../../index.md) / [TabsUseCases](../index.md) / [AddNewPrivateTabUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`fun invoke(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L91) + +Overrides [LoadUrlUseCase.invoke](../../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/invoke.md) + +Adds a new private tab and loads the provided URL. + +### Parameters + +`url` - The URL to be loaded in the new private tab.`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, startLoading: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, parent: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = null): `[`Session`](../../../mozilla.components.browser.session/-session/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L103) + +Adds a new private tab and loads 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. + +`startLoading` - True (default) if the new tab should start loading immediately. + +`parent` - the parent session to use for the newly created session. \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-tab-use-case/index.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-tab-use-case/index.md new file mode 100644 index 00000000000..f41596d5ecb --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-tab-use-case/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.tabs](../../index.md) / [TabsUseCases](../index.md) / [AddNewTabUseCase](./index.md) + +# AddNewTabUseCase + +`class AddNewTabUseCase : `[`LoadUrlUseCase`](../../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L44) + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `fun invoke(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)
`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, startLoading: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, parent: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = null): `[`Session`](../../../mozilla.components.browser.session/-session/index.md)
Adds a new tab and loads the provided URL. | diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-tab-use-case/invoke.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-tab-use-case/invoke.md new file mode 100644 index 00000000000..929c98f743d --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-add-new-tab-use-case/invoke.md @@ -0,0 +1,25 @@ +[android-components](../../../index.md) / [mozilla.components.feature.tabs](../../index.md) / [TabsUseCases](../index.md) / [AddNewTabUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`fun invoke(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L53) + +Overrides [LoadUrlUseCase.invoke](../../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/invoke.md) + +Adds a new tab and loads the provided URL. + +### Parameters + +`url` - The URL to be loaded in the new tab.`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, startLoading: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, parent: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`? = null): `[`Session`](../../../mozilla.components.browser.session/-session/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L65) + +Adds a new tab and loads 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. + +`startLoading` - True (default) if the new tab should start loading immediately. + +`parent` - the parent session to use for the newly created session. \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-init-.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-init-.md new file mode 100644 index 00000000000..697fc0239fe --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs](../index.md) / [TabsUseCases](index.md) / [<init>](./-init-.md) + +# <init> + +`TabsUseCases(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`)` + +Contains use cases related to the tabs feature. + diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-all-tabs-of-type-use-case/index.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-all-tabs-of-type-use-case/index.md new file mode 100644 index 00000000000..cc238bf3aa6 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-all-tabs-of-type-use-case/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.tabs](../../index.md) / [TabsUseCases](../index.md) / [RemoveAllTabsOfTypeUseCase](./index.md) + +# RemoveAllTabsOfTypeUseCase + +`class RemoveAllTabsOfTypeUseCase` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L128) + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `fun invoke(private: `[`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/mozilla.components.feature.tabs/-tabs-use-cases/-remove-all-tabs-of-type-use-case/invoke.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-all-tabs-of-type-use-case/invoke.md new file mode 100644 index 00000000000..047531b33d3 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-all-tabs-of-type-use-case/invoke.md @@ -0,0 +1,9 @@ +[android-components](../../../index.md) / [mozilla.components.feature.tabs](../../index.md) / [TabsUseCases](../index.md) / [RemoveAllTabsOfTypeUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`fun invoke(private: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L135) + +### Parameters + +`private` - pass true if only private tabs should be removed otherwise normal tabs will be removed \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-all-tabs-use-case/index.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-all-tabs-use-case/index.md new file mode 100644 index 00000000000..18b7c60f4bb --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-all-tabs-use-case/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.tabs](../../index.md) / [TabsUseCases](../index.md) / [RemoveAllTabsUseCase](./index.md) + +# RemoveAllTabsUseCase + +`class RemoveAllTabsUseCase` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L120) + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `fun invoke(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-all-tabs-use-case/invoke.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-all-tabs-use-case/invoke.md new file mode 100644 index 00000000000..9de20ab03ad --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-all-tabs-use-case/invoke.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.feature.tabs](../../index.md) / [TabsUseCases](../index.md) / [RemoveAllTabsUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`fun invoke(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L123) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/index.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/index.md new file mode 100644 index 00000000000..c2118cce673 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.tabs](../../index.md) / [TabsUseCases](../index.md) / [RemoveTabUseCase](./index.md) + +# RemoveTabUseCase + +`class RemoveTabUseCase` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L31) + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `fun invoke(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Removes the provided session. | diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/invoke.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/invoke.md new file mode 100644 index 00000000000..552a687105a --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-remove-tab-use-case/invoke.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.tabs](../../index.md) / [TabsUseCases](../index.md) / [RemoveTabUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`fun invoke(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L39) + +Removes the provided session. + +### Parameters + +`session` - The session to remove. \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/index.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/index.md new file mode 100644 index 00000000000..c3da3ce6855 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.tabs](../../index.md) / [TabsUseCases](../index.md) / [SelectTabUseCase](./index.md) + +# SelectTabUseCase + +`class SelectTabUseCase` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L18) + +### Functions + +| Name | Summary | +|---|---| +| [invoke](invoke.md) | `fun invoke(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Marks the provided session as selected. | diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/invoke.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/invoke.md new file mode 100644 index 00000000000..e5c51249fe2 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/-select-tab-use-case/invoke.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.feature.tabs](../../index.md) / [TabsUseCases](../index.md) / [SelectTabUseCase](index.md) / [invoke](./invoke.md) + +# invoke + +`fun invoke(session: `[`Session`](../../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L26) + +Marks the provided session as selected. + +### Parameters + +`session` - The session to select. \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/add-private-tab.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/add-private-tab.md new file mode 100644 index 00000000000..3131ed16322 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/add-private-tab.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs](../index.md) / [TabsUseCases](index.md) / [addPrivateTab](./add-private-tab.md) + +# addPrivateTab + +`val addPrivateTab: `[`AddNewPrivateTabUseCase`](-add-new-private-tab-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L146) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/add-tab.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/add-tab.md new file mode 100644 index 00000000000..5cf853e9016 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/add-tab.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs](../index.md) / [TabsUseCases](index.md) / [addTab](./add-tab.md) + +# addTab + +`val addTab: `[`AddNewTabUseCase`](-add-new-tab-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L145) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/index.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/index.md new file mode 100644 index 00000000000..d021d21aaf1 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/index.md @@ -0,0 +1,35 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs](../index.md) / [TabsUseCases](./index.md) + +# TabsUseCases + +`class TabsUseCases` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L15) + +Contains use cases related to the tabs feature. + +### Types + +| Name | Summary | +|---|---| +| [AddNewPrivateTabUseCase](-add-new-private-tab-use-case/index.md) | `class AddNewPrivateTabUseCase : `[`LoadUrlUseCase`](../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md) | +| [AddNewTabUseCase](-add-new-tab-use-case/index.md) | `class AddNewTabUseCase : `[`LoadUrlUseCase`](../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md) | +| [RemoveAllTabsOfTypeUseCase](-remove-all-tabs-of-type-use-case/index.md) | `class RemoveAllTabsOfTypeUseCase` | +| [RemoveAllTabsUseCase](-remove-all-tabs-use-case/index.md) | `class RemoveAllTabsUseCase` | +| [RemoveTabUseCase](-remove-tab-use-case/index.md) | `class RemoveTabUseCase` | +| [SelectTabUseCase](-select-tab-use-case/index.md) | `class SelectTabUseCase` | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TabsUseCases(sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`)`
Contains use cases related to the tabs feature. | + +### Properties + +| Name | Summary | +|---|---| +| [addPrivateTab](add-private-tab.md) | `val addPrivateTab: `[`AddNewPrivateTabUseCase`](-add-new-private-tab-use-case/index.md) | +| [addTab](add-tab.md) | `val addTab: `[`AddNewTabUseCase`](-add-new-tab-use-case/index.md) | +| [removeAllTabs](remove-all-tabs.md) | `val removeAllTabs: `[`RemoveAllTabsUseCase`](-remove-all-tabs-use-case/index.md) | +| [removeAllTabsOfType](remove-all-tabs-of-type.md) | `val removeAllTabsOfType: `[`RemoveAllTabsOfTypeUseCase`](-remove-all-tabs-of-type-use-case/index.md) | +| [removeTab](remove-tab.md) | `val removeTab: `[`RemoveTabUseCase`](-remove-tab-use-case/index.md) | +| [selectTab](select-tab.md) | `val selectTab: `[`SelectTabUseCase`](-select-tab-use-case/index.md) | diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/remove-all-tabs-of-type.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/remove-all-tabs-of-type.md new file mode 100644 index 00000000000..861a78fb541 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/remove-all-tabs-of-type.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs](../index.md) / [TabsUseCases](index.md) / [removeAllTabsOfType](./remove-all-tabs-of-type.md) + +# removeAllTabsOfType + +`val removeAllTabsOfType: `[`RemoveAllTabsOfTypeUseCase`](-remove-all-tabs-of-type-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L148) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/remove-all-tabs.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/remove-all-tabs.md new file mode 100644 index 00000000000..10de9e68541 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/remove-all-tabs.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs](../index.md) / [TabsUseCases](index.md) / [removeAllTabs](./remove-all-tabs.md) + +# removeAllTabs + +`val removeAllTabs: `[`RemoveAllTabsUseCase`](-remove-all-tabs-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L147) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/remove-tab.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/remove-tab.md new file mode 100644 index 00000000000..cbd96da24a9 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/remove-tab.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs](../index.md) / [TabsUseCases](index.md) / [removeTab](./remove-tab.md) + +# removeTab + +`val removeTab: `[`RemoveTabUseCase`](-remove-tab-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L144) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/select-tab.md b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/select-tab.md new file mode 100644 index 00000000000..3824a310fd7 --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/-tabs-use-cases/select-tab.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.tabs](../index.md) / [TabsUseCases](index.md) / [selectTab](./select-tab.md) + +# selectTab + +`val selectTab: `[`SelectTabUseCase`](-select-tab-use-case/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/tabs/src/main/java/mozilla/components/feature/tabs/TabsUseCases.kt#L143) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.tabs/index.md b/docs/api/mozilla.components.feature.tabs/index.md new file mode 100644 index 00000000000..f618180c1ea --- /dev/null +++ b/docs/api/mozilla.components.feature.tabs/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.feature.tabs](./index.md) + +## Package mozilla.components.feature.tabs + +### Types + +| Name | Summary | +|---|---| +| [TabsUseCases](-tabs-use-cases/index.md) | `class TabsUseCases`
Contains use cases related to the tabs feature. | diff --git a/docs/api/mozilla.components.feature.toolbar/-search-use-case.md b/docs/api/mozilla.components.feature.toolbar/-search-use-case.md new file mode 100644 index 00000000000..90267ec979b --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-search-use-case.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.feature.toolbar](index.md) / [SearchUseCase](./-search-use-case.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarFeature.kt#L17) + +A function representing the search use case, accepting +the search terms as string. + diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/-init-.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/-init-.md new file mode 100644 index 00000000000..6e0e70a388a --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarAutocompleteFeature](index.md) / [<init>](./-init-.md) + +# <init> + +`ToolbarAutocompleteFeature(toolbar: `[`Toolbar`](../../mozilla.components.concept.toolbar/-toolbar/index.md)`)` + +Feature implementation for connecting a toolbar with a list of autocomplete providers. + diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/add-domain-provider.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/add-domain-provider.md new file mode 100644 index 00000000000..8918004eb29 --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/add-domain-provider.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarAutocompleteFeature](index.md) / [addDomainProvider](./add-domain-provider.md) + +# addDomainProvider + +`fun addDomainProvider(provider: `[`DomainAutocompleteProvider`](../../mozilla.components.browser.domains.autocomplete/-domain-autocomplete-provider/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarAutocompleteFeature.kt#L39) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/add-history-storage-provider.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/add-history-storage-provider.md new file mode 100644 index 00000000000..513c6f8dcdb --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/add-history-storage-provider.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarAutocompleteFeature](index.md) / [addHistoryStorageProvider](./add-history-storage-provider.md) + +# addHistoryStorageProvider + +`fun addHistoryStorageProvider(provider: `[`HistoryStorage`](../../mozilla.components.concept.storage/-history-storage/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarAutocompleteFeature.kt#L35) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/index.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/index.md new file mode 100644 index 00000000000..6f35c8d88fd --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/index.md @@ -0,0 +1,26 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarAutocompleteFeature](./index.md) + +# ToolbarAutocompleteFeature + +`class ToolbarAutocompleteFeature` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarAutocompleteFeature.kt#L17) + +Feature implementation for connecting a toolbar with a list of autocomplete providers. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ToolbarAutocompleteFeature(toolbar: `[`Toolbar`](../../mozilla.components.concept.toolbar/-toolbar/index.md)`)`
Feature implementation for connecting a toolbar with a list of autocomplete providers. | + +### Properties + +| Name | Summary | +|---|---| +| [toolbar](toolbar.md) | `val toolbar: `[`Toolbar`](../../mozilla.components.concept.toolbar/-toolbar/index.md) | + +### Functions + +| Name | Summary | +|---|---| +| [addDomainProvider](add-domain-provider.md) | `fun addDomainProvider(provider: `[`DomainAutocompleteProvider`](../../mozilla.components.browser.domains.autocomplete/-domain-autocomplete-provider/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [addHistoryStorageProvider](add-history-storage-provider.md) | `fun addHistoryStorageProvider(provider: `[`HistoryStorage`](../../mozilla.components.concept.storage/-history-storage/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/toolbar.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/toolbar.md new file mode 100644 index 00000000000..d17fb7cfcd7 --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-autocomplete-feature/toolbar.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarAutocompleteFeature](index.md) / [toolbar](./toolbar.md) + +# toolbar + +`val toolbar: `[`Toolbar`](../../mozilla.components.concept.toolbar/-toolbar/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarAutocompleteFeature.kt#L17) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-feature/-init-.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-feature/-init-.md new file mode 100644 index 00000000000..74d4d30d1de --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-feature/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarFeature](index.md) / [<init>](./-init-.md) + +# <init> + +`ToolbarFeature(toolbar: `[`Toolbar`](../../mozilla.components.concept.toolbar/-toolbar/index.md)`, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, loadUrlUseCase: `[`LoadUrlUseCase`](../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md)`, searchUseCase: `[`SearchUseCase`](../-search-use-case.md)`? = 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/mozilla.components.feature.toolbar/-toolbar-feature/index.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-feature/index.md new file mode 100644 index 00000000000..f2b64a85748 --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-feature/index.md @@ -0,0 +1,27 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarFeature](./index.md) + +# ToolbarFeature + +`class ToolbarFeature : `[`LifecycleAwareFeature`](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)`, `[`BackHandler`](../../mozilla.components.support.base.feature/-back-handler/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarFeature.kt#L22) + +Feature implementation for connecting a toolbar implementation with the session module. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ToolbarFeature(toolbar: `[`Toolbar`](../../mozilla.components.concept.toolbar/-toolbar/index.md)`, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, loadUrlUseCase: `[`LoadUrlUseCase`](../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md)`, searchUseCase: `[`SearchUseCase`](../-search-use-case.md)`? = 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 + +| Name | Summary | +|---|---| +| [toolbar](toolbar.md) | `val toolbar: `[`Toolbar`](../../mozilla.components.concept.toolbar/-toolbar/index.md) | + +### Functions + +| Name | Summary | +|---|---| +| [onBackPressed](on-back-pressed.md) | `fun onBackPressed(): `[`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.md) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Start feature: App is in the foreground. | +| [stop](stop.md) | `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/mozilla.components.feature.toolbar/-toolbar-feature/on-back-pressed.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-feature/on-back-pressed.md new file mode 100644 index 00000000000..8ebafa30b43 --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-feature/on-back-pressed.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarFeature](index.md) / [onBackPressed](./on-back-pressed.md) + +# onBackPressed + +`fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarFeature.kt#L45) + +Overrides [BackHandler.onBackPressed](../../mozilla.components.support.base.feature/-back-handler/on-back-pressed.md) + +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/mozilla.components.feature.toolbar/-toolbar-feature/start.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-feature/start.md new file mode 100644 index 00000000000..d97969ca454 --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-feature/start.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarFeature](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarFeature.kt#L35) + +Overrides [LifecycleAwareFeature.start](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/start.md) + +Start feature: App is in the foreground. + diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-feature/stop.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-feature/stop.md new file mode 100644 index 00000000000..8ffcc8b1886 --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-feature/stop.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarFeature](index.md) / [stop](./stop.md) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarFeature.kt#L52) + +Overrides [LifecycleAwareFeature.stop](../../mozilla.components.support.base.feature/-lifecycle-aware-feature/stop.md) + +Stop feature: App is in the background. + diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-feature/toolbar.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-feature/toolbar.md new file mode 100644 index 00000000000..94c15051249 --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-feature/toolbar.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarFeature](index.md) / [toolbar](./toolbar.md) + +# toolbar + +`val toolbar: `[`Toolbar`](../../mozilla.components.concept.toolbar/-toolbar/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarFeature.kt#L23) \ No newline at end of file diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-interactor/-init-.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-interactor/-init-.md new file mode 100644 index 00000000000..648cb00448a --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-interactor/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarInteractor](index.md) / [<init>](./-init-.md) + +# <init> + +`ToolbarInteractor(toolbar: `[`Toolbar`](../../mozilla.components.concept.toolbar/-toolbar/index.md)`, loadUrlUseCase: `[`LoadUrlUseCase`](../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md)`, searchUseCase: `[`SearchUseCase`](../-search-use-case.md)`? = null)` + +Connects a toolbar instance to the browser engine via use cases + diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-interactor/index.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-interactor/index.md new file mode 100644 index 00000000000..5851ae74f96 --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-interactor/index.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarInteractor](./index.md) + +# ToolbarInteractor + +`class ToolbarInteractor` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarInteractor.kt#L15) + +Connects a toolbar instance to the browser engine via use cases + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ToolbarInteractor(toolbar: `[`Toolbar`](../../mozilla.components.concept.toolbar/-toolbar/index.md)`, loadUrlUseCase: `[`LoadUrlUseCase`](../../mozilla.components.feature.session/-session-use-cases/-load-url-use-case/index.md)`, searchUseCase: `[`SearchUseCase`](../-search-use-case.md)`? = null)`
Connects a toolbar instance to the browser engine via use cases | + +### Functions + +| Name | Summary | +|---|---| +| [start](start.md) | `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.md) | `fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stops this interactor. | diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-interactor/start.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-interactor/start.md new file mode 100644 index 00000000000..13d9017f3cf --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-interactor/start.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarInteractor](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarInteractor.kt#L26) + +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/mozilla.components.feature.toolbar/-toolbar-interactor/stop.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-interactor/stop.md new file mode 100644 index 00000000000..7854bf273f8 --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-interactor/stop.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarInteractor](index.md) / [stop](./stop.md) + +# stop + +`fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarInteractor.kt#L39) + +Stops this interactor. + diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/-init-.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/-init-.md new file mode 100644 index 00000000000..fbe696838b0 --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarPresenter](index.md) / [<init>](./-init-.md) + +# <init> + +`ToolbarPresenter(toolbar: `[`Toolbar`](../../mozilla.components.concept.toolbar/-toolbar/index.md)`, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, 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/mozilla.components.feature.toolbar/-toolbar-presenter/index.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/index.md new file mode 100644 index 00000000000..c5838f9eb69 --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/index.md @@ -0,0 +1,39 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarPresenter](./index.md) + +# ToolbarPresenter + +`class ToolbarPresenter : `[`SelectionAwareSessionObserver`](../../mozilla.components.browser.session/-selection-aware-session-observer/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarPresenter.kt#L16) + +Presenter implementation for a toolbar implementation in order to update the toolbar whenever +the state of the selected session changes. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ToolbarPresenter(toolbar: `[`Toolbar`](../../mozilla.components.concept.toolbar/-toolbar/index.md)`, sessionManager: `[`SessionManager`](../../mozilla.components.browser.session/-session-manager/index.md)`, 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. | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [activeSession](../../mozilla.components.browser.session/-selection-aware-session-observer/active-session.md) | `open var activeSession: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`?`
the currently observed session | + +### Functions + +| Name | Summary | +|---|---| +| [onProgress](on-progress.md) | `fun onProgress(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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.md) | `fun onSearch(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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.md) | `fun onSecurityChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, securityInfo: `[`SecurityInfo`](../../mozilla.components.browser.session/-session/-security-info/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onSessionSelected](on-session-selected.md) | `fun onSessionSelected(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`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.md) | `fun onUrlChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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.md) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Start presenter: Display data in toolbar. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [observeFixed](../../mozilla.components.browser.session/-selection-aware-session-observer/observe-fixed.md) | `fun observeFixed(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts observing changes to the specified session. | +| [observeSelected](../../mozilla.components.browser.session/-selection-aware-session-observer/observe-selected.md) | `fun observeSelected(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Starts observing changes to the selected session (see [SessionManager.selectedSession](../../mozilla.components.browser.session/-session-manager/selected-session.md)). If a different session is selected the observer will automatically be switched over and only notified of changes to the newly selected session. | +| [stop](../../mozilla.components.browser.session/-selection-aware-session-observer/stop.md) | `open fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stops the observer. | diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-progress.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-progress.md new file mode 100644 index 00000000000..85ead857d5c --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-progress.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarPresenter](index.md) / [onProgress](./on-progress.md) + +# onProgress + +`fun onProgress(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarPresenter.kt#L52) + +Overrides [Observer.onProgress](../../mozilla.components.browser.session/-session/-observer/on-progress.md) + diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-search.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-search.md new file mode 100644 index 00000000000..c00399d5614 --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-search.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarPresenter](index.md) / [onSearch](./on-search.md) + +# onSearch + +`fun onSearch(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarPresenter.kt#L56) + +Overrides [Observer.onSearch](../../mozilla.components.browser.session/-session/-observer/on-search.md) + diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-security-changed.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-security-changed.md new file mode 100644 index 00000000000..8b27424b458 --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-security-changed.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarPresenter](index.md) / [onSecurityChanged](./on-security-changed.md) + +# onSecurityChanged + +`fun onSecurityChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, securityInfo: `[`SecurityInfo`](../../mozilla.components.browser.session/-session/-security-info/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarPresenter.kt#L60) + +Overrides [Observer.onSecurityChanged](../../mozilla.components.browser.session/-session/-observer/on-security-changed.md) + diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-session-selected.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-session-selected.md new file mode 100644 index 00000000000..7f3f2640421 --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-session-selected.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarPresenter](index.md) / [onSessionSelected](./on-session-selected.md) + +# onSessionSelected + +`fun onSessionSelected(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarPresenter.kt#L34) + +Overrides [SelectionAwareSessionObserver.onSessionSelected](../../mozilla.components.browser.session/-selection-aware-session-observer/on-session-selected.md) + +A new session has been selected: Update toolbar to display data of new session. + diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-url-changed.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-url-changed.md new file mode 100644 index 00000000000..e6ec4f18329 --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/on-url-changed.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarPresenter](index.md) / [onUrlChanged](./on-url-changed.md) + +# onUrlChanged + +`fun onUrlChanged(session: `[`Session`](../../mozilla.components.browser.session/-session/index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarPresenter.kt#L47) + +Overrides [Observer.onUrlChanged](../../mozilla.components.browser.session/-session/-observer/on-url-changed.md) + diff --git a/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/start.md b/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/start.md new file mode 100644 index 00000000000..8908a9ee3c6 --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/-toolbar-presenter/start.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.feature.toolbar](../index.md) / [ToolbarPresenter](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/feature/toolbar/src/main/java/mozilla/components/feature/toolbar/ToolbarPresenter.kt#L25) + +Start presenter: Display data in toolbar. + diff --git a/docs/api/mozilla.components.feature.toolbar/index.md b/docs/api/mozilla.components.feature.toolbar/index.md new file mode 100644 index 00000000000..164fbcbb074 --- /dev/null +++ b/docs/api/mozilla.components.feature.toolbar/index.md @@ -0,0 +1,18 @@ +[android-components](../index.md) / [mozilla.components.feature.toolbar](./index.md) + +## Package mozilla.components.feature.toolbar + +### Types + +| Name | Summary | +|---|---| +| [ToolbarAutocompleteFeature](-toolbar-autocomplete-feature/index.md) | `class ToolbarAutocompleteFeature`
Feature implementation for connecting a toolbar with a list of autocomplete providers. | +| [ToolbarFeature](-toolbar-feature/index.md) | `class ToolbarFeature : `[`LifecycleAwareFeature`](../mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md)`, `[`BackHandler`](../mozilla.components.support.base.feature/-back-handler/index.md)
Feature implementation for connecting a toolbar implementation with the session module. | +| [ToolbarInteractor](-toolbar-interactor/index.md) | `class ToolbarInteractor`
Connects a toolbar instance to the browser engine via use cases | +| [ToolbarPresenter](-toolbar-presenter/index.md) | `class ToolbarPresenter : `[`SelectionAwareSessionObserver`](../mozilla.components.browser.session/-selection-aware-session-observer/index.md)
Presenter implementation for a toolbar implementation in order to update the toolbar whenever the state of the selected session changes. | + +### Type Aliases + +| Name | Summary | +|---|---| +| [SearchUseCase](-search-use-case.md) | `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/mozilla.components.lib.crash.handler/-crash-handler-service/-init-.md b/docs/api/mozilla.components.lib.crash.handler/-crash-handler-service/-init-.md new file mode 100644 index 00000000000..2ebf602f82a --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.handler/-crash-handler-service/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.handler](../index.md) / [CrashHandlerService](index.md) / [<init>](./-init-.md) + +# <init> + +`CrashHandlerService()` + +Service receiving native code crashes (from GeckoView). + diff --git a/docs/api/mozilla.components.lib.crash.handler/-crash-handler-service/index.md b/docs/api/mozilla.components.lib.crash.handler/-crash-handler-service/index.md new file mode 100644 index 00000000000..28c49e57908 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.handler/-crash-handler-service/index.md @@ -0,0 +1,34 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.handler](../index.md) / [CrashHandlerService](./index.md) + +# CrashHandlerService + +`class CrashHandlerService : `[`IntentService`](https://developer.android.com/reference/android/app/IntentService.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/handler/CrashHandlerService.kt#L17) + +Service receiving native code crashes (from GeckoView). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `CrashHandlerService()`
Service receiving native code crashes (from GeckoView). | + +### Functions + +| Name | Summary | +|---|---| +| [onHandleIntent](on-handle-intent.md) | `fun onHandleIntent(intent: `[`Intent`](https://developer.android.com/reference/android/content/Intent.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Extension Properties + +| Name | Summary | +|---|---| +| [appVersionName](../../mozilla.components.support.ktx.android.content/android.content.-context/app-version-name.md) | `val `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.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". | + +### Extension Functions + +| Name | Summary | +|---|---| +| [isOSOnLowMemory](../../mozilla.components.support.ktx.android.content/android.content.-context/is-o-s-on-low-memory.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.isOSOnLowMemory(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns whether or not the operating system is under low memory conditions. | +| [isPermissionGranted](../../mozilla.components.support.ktx.android.content/android.content.-context/is-permission-granted.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.isPermissionGranted(vararg permission: `[`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 if a list of permission have been granted, if all the permission have been granted returns true otherwise false. | +| [share](../../mozilla.components.support.ktx.android.content/android.content.-context/share.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.share(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, subject: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getString(R.string.mozac_support_ktx_share_dialog_title)): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Shares content via [ACTION_SEND](https://developer.android.com/reference/android/content/Intent.html#ACTION_SEND) intent. | +| [systemService](../../mozilla.components.support.ktx.android.content/android.content.-context/system-service.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.systemService(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](../../mozilla.components.support.ktx.android.content/android.content.-context/system-service.md#T)
Returns the handle to a system-level service by name. | diff --git a/docs/api/mozilla.components.lib.crash.handler/-crash-handler-service/on-handle-intent.md b/docs/api/mozilla.components.lib.crash.handler/-crash-handler-service/on-handle-intent.md new file mode 100644 index 00000000000..78ec84f8106 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.handler/-crash-handler-service/on-handle-intent.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.handler](../index.md) / [CrashHandlerService](index.md) / [onHandleIntent](./on-handle-intent.md) + +# onHandleIntent + +`fun onHandleIntent(intent: `[`Intent`](https://developer.android.com/reference/android/content/Intent.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/handler/CrashHandlerService.kt#L23) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.crash.handler/-exception-handler/-init-.md b/docs/api/mozilla.components.lib.crash.handler/-exception-handler/-init-.md new file mode 100644 index 00000000000..a7b749b21b7 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.handler/-exception-handler/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.handler](../index.md) / [ExceptionHandler](index.md) / [<init>](./-init-.md) + +# <init> + +`ExceptionHandler(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, crashReporter: `[`CrashReporter`](../../mozilla.components.lib.crash/-crash-reporter/index.md)`, defaultExceptionHandler: `[`UncaughtExceptionHandler`](https://developer.android.com/reference/java/lang/Thread/UncaughtExceptionHandler.html)`? = null)` + +[Thread.UncaughtExceptionHandler](https://developer.android.com/reference/java/lang/Thread/UncaughtExceptionHandler.html) implementation that forwards crashes to the [CrashReporter](../../mozilla.components.lib.crash/-crash-reporter/index.md) instance. + diff --git a/docs/api/mozilla.components.lib.crash.handler/-exception-handler/index.md b/docs/api/mozilla.components.lib.crash.handler/-exception-handler/index.md new file mode 100644 index 00000000000..42662cdce50 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.handler/-exception-handler/index.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.handler](../index.md) / [ExceptionHandler](./index.md) + +# ExceptionHandler + +`class ExceptionHandler : `[`UncaughtExceptionHandler`](https://developer.android.com/reference/java/lang/Thread/UncaughtExceptionHandler.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/handler/ExceptionHandler.kt#L15) + +[Thread.UncaughtExceptionHandler](https://developer.android.com/reference/java/lang/Thread/UncaughtExceptionHandler.html) implementation that forwards crashes to the [CrashReporter](../../mozilla.components.lib.crash/-crash-reporter/index.md) instance. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ExceptionHandler(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, crashReporter: `[`CrashReporter`](../../mozilla.components.lib.crash/-crash-reporter/index.md)`, defaultExceptionHandler: `[`UncaughtExceptionHandler`](https://developer.android.com/reference/java/lang/Thread/UncaughtExceptionHandler.html)`? = null)`
[Thread.UncaughtExceptionHandler](https://developer.android.com/reference/java/lang/Thread/UncaughtExceptionHandler.html) implementation that forwards crashes to the [CrashReporter](../../mozilla.components.lib.crash/-crash-reporter/index.md) instance. | + +### Functions + +| Name | Summary | +|---|---| +| [uncaughtException](uncaught-exception.md) | `fun uncaughtException(thread: `[`Thread`](https://developer.android.com/reference/java/lang/Thread.html)`, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.lib.crash.handler/-exception-handler/uncaught-exception.md b/docs/api/mozilla.components.lib.crash.handler/-exception-handler/uncaught-exception.md new file mode 100644 index 00000000000..751560b3fa8 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.handler/-exception-handler/uncaught-exception.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.handler](../index.md) / [ExceptionHandler](index.md) / [uncaughtException](./uncaught-exception.md) + +# uncaughtException + +`fun uncaughtException(thread: `[`Thread`](https://developer.android.com/reference/java/lang/Thread.html)`, throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/handler/ExceptionHandler.kt#L22) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.crash.handler/index.md b/docs/api/mozilla.components.lib.crash.handler/index.md new file mode 100644 index 00000000000..8259fc2528b --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.handler/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.lib.crash.handler](./index.md) + +## Package mozilla.components.lib.crash.handler + +### Types + +| Name | Summary | +|---|---| +| [CrashHandlerService](-crash-handler-service/index.md) | `class CrashHandlerService : `[`IntentService`](https://developer.android.com/reference/android/app/IntentService.html)
Service receiving native code crashes (from GeckoView). | +| [ExceptionHandler](-exception-handler/index.md) | `class ExceptionHandler : `[`UncaughtExceptionHandler`](https://developer.android.com/reference/java/lang/Thread/UncaughtExceptionHandler.html)
[Thread.UncaughtExceptionHandler](https://developer.android.com/reference/java/lang/Thread/UncaughtExceptionHandler.html) implementation that forwards crashes to the [CrashReporter](../mozilla.components.lib.crash/-crash-reporter/index.md) instance. | diff --git a/docs/api/mozilla.components.lib.crash.prompt/-crash-reporter-activity/-init-.md b/docs/api/mozilla.components.lib.crash.prompt/-crash-reporter-activity/-init-.md new file mode 100644 index 00000000000..dba9ee3f872 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.prompt/-crash-reporter-activity/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.prompt](../index.md) / [CrashReporterActivity](index.md) / [<init>](./-init-.md) + +# <init> + +`CrashReporterActivity()` + +Activity showing the crash reporter prompt asking the user for confirmation before submitting a crash report. + diff --git a/docs/api/mozilla.components.lib.crash.prompt/-crash-reporter-activity/index.md b/docs/api/mozilla.components.lib.crash.prompt/-crash-reporter-activity/index.md new file mode 100644 index 00000000000..4a7ca22e601 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.prompt/-crash-reporter-activity/index.md @@ -0,0 +1,37 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.prompt](../index.md) / [CrashReporterActivity](./index.md) + +# CrashReporterActivity + +`class CrashReporterActivity : AppCompatActivity` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/prompt/CrashReporterActivity.kt#L26) + +Activity showing the crash reporter prompt asking the user for confirmation before submitting a crash report. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `CrashReporterActivity()`
Activity showing the crash reporter prompt asking the user for confirmation before submitting a crash report. | + +### Functions + +| Name | Summary | +|---|---| +| [onBackPressed](on-back-pressed.md) | `fun onBackPressed(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onCreate](on-create.md) | `fun onCreate(savedInstanceState: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Extension Properties + +| Name | Summary | +|---|---| +| [appVersionName](../../mozilla.components.support.ktx.android.content/android.content.-context/app-version-name.md) | `val `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.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". | + +### Extension Functions + +| Name | Summary | +|---|---| +| [enterToImmersiveMode](../../mozilla.components.support.ktx.android.view/android.app.-activity/enter-to-immersive-mode.md) | `fun `[`Activity`](https://developer.android.com/reference/android/app/Activity.html)`.enterToImmersiveMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Attempts to call immersive mode using the View to hide the status bar and navigation buttons. | +| [exitImmersiveModeIfNeeded](../../mozilla.components.support.ktx.android.view/android.app.-activity/exit-immersive-mode-if-needed.md) | `fun `[`Activity`](https://developer.android.com/reference/android/app/Activity.html)`.exitImmersiveModeIfNeeded(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Attempts to come out from immersive mode using the View. | +| [isOSOnLowMemory](../../mozilla.components.support.ktx.android.content/android.content.-context/is-o-s-on-low-memory.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.isOSOnLowMemory(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns whether or not the operating system is under low memory conditions. | +| [isPermissionGranted](../../mozilla.components.support.ktx.android.content/android.content.-context/is-permission-granted.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.isPermissionGranted(vararg permission: `[`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 if a list of permission have been granted, if all the permission have been granted returns true otherwise false. | +| [share](../../mozilla.components.support.ktx.android.content/android.content.-context/share.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.share(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, subject: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getString(R.string.mozac_support_ktx_share_dialog_title)): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Shares content via [ACTION_SEND](https://developer.android.com/reference/android/content/Intent.html#ACTION_SEND) intent. | +| [systemService](../../mozilla.components.support.ktx.android.content/android.content.-context/system-service.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.systemService(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](../../mozilla.components.support.ktx.android.content/android.content.-context/system-service.md#T)
Returns the handle to a system-level service by name. | diff --git a/docs/api/mozilla.components.lib.crash.prompt/-crash-reporter-activity/on-back-pressed.md b/docs/api/mozilla.components.lib.crash.prompt/-crash-reporter-activity/on-back-pressed.md new file mode 100644 index 00000000000..fbb2ae17a99 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.prompt/-crash-reporter-activity/on-back-pressed.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.prompt](../index.md) / [CrashReporterActivity](index.md) / [onBackPressed](./on-back-pressed.md) + +# onBackPressed + +`fun onBackPressed(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/prompt/CrashReporterActivity.kt#L100) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.crash.prompt/-crash-reporter-activity/on-create.md b/docs/api/mozilla.components.lib.crash.prompt/-crash-reporter-activity/on-create.md new file mode 100644 index 00000000000..95ec522976f --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.prompt/-crash-reporter-activity/on-create.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.prompt](../index.md) / [CrashReporterActivity](index.md) / [onCreate](./on-create.md) + +# onCreate + +`protected fun onCreate(savedInstanceState: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/prompt/CrashReporterActivity.kt#L33) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.crash.prompt/index.md b/docs/api/mozilla.components.lib.crash.prompt/index.md new file mode 100644 index 00000000000..f597efa208e --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.prompt/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.lib.crash.prompt](./index.md) + +## Package mozilla.components.lib.crash.prompt + +### Types + +| Name | Summary | +|---|---| +| [CrashReporterActivity](-crash-reporter-activity/index.md) | `class CrashReporterActivity : AppCompatActivity`
Activity showing the crash reporter prompt asking the user for confirmation before submitting a crash report. | diff --git a/docs/api/mozilla.components.lib.crash.service/-crash-reporter-service/index.md b/docs/api/mozilla.components.lib.crash.service/-crash-reporter-service/index.md new file mode 100644 index 00000000000..3c6f5deee49 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.service/-crash-reporter-service/index.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.service](../index.md) / [CrashReporterService](./index.md) + +# CrashReporterService + +`interface CrashReporterService` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/service/CrashReporterService.kt#L12) + +Interface to be implemented by external services that accept crash reports. + +### Functions + +| Name | Summary | +|---|---| +| [report](report.md) | `abstract fun report(crash: `[`UncaughtExceptionCrash`](../../mozilla.components.lib.crash/-crash/-uncaught-exception-crash/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Submits a crash report for this [Crash.UncaughtExceptionCrash](../../mozilla.components.lib.crash/-crash/-uncaught-exception-crash/index.md).`abstract fun report(crash: `[`NativeCodeCrash`](../../mozilla.components.lib.crash/-crash/-native-code-crash/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Submits a crash report for this [Crash.NativeCodeCrash](../../mozilla.components.lib.crash/-crash/-native-code-crash/index.md). | + +### Inheritors + +| Name | Summary | +|---|---| +| [MozillaSocorroService](../-mozilla-socorro-service/index.md) | `class MozillaSocorroService : `[`CrashReporterService`](./index.md)
A [CrashReporterService](./index.md) implementation uploading crash reports to crash-stats.mozilla.com. | +| [SentryService](../-sentry-service/index.md) | `class SentryService : `[`CrashReporterService`](./index.md)
A [CrashReporterService](./index.md) implementation that uploads crash reports to a Sentry server. | diff --git a/docs/api/mozilla.components.lib.crash.service/-crash-reporter-service/report.md b/docs/api/mozilla.components.lib.crash.service/-crash-reporter-service/report.md new file mode 100644 index 00000000000..08b7b9f61fd --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.service/-crash-reporter-service/report.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.service](../index.md) / [CrashReporterService](index.md) / [report](./report.md) + +# report + +`abstract fun report(crash: `[`UncaughtExceptionCrash`](../../mozilla.components.lib.crash/-crash/-uncaught-exception-crash/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/service/CrashReporterService.kt#L16) + +Submits a crash report for this [Crash.UncaughtExceptionCrash](../../mozilla.components.lib.crash/-crash/-uncaught-exception-crash/index.md). + +`abstract fun report(crash: `[`NativeCodeCrash`](../../mozilla.components.lib.crash/-crash/-native-code-crash/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/service/CrashReporterService.kt#L21) + +Submits a crash report for this [Crash.NativeCodeCrash](../../mozilla.components.lib.crash/-crash/-native-code-crash/index.md). + diff --git a/docs/api/mozilla.components.lib.crash.service/-gecko-crash-reporter.md b/docs/api/mozilla.components.lib.crash.service/-gecko-crash-reporter.md new file mode 100644 index 00000000000..f5a469f70b9 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.service/-gecko-crash-reporter.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.lib.crash.service](index.md) / [GeckoCrashReporter](./-gecko-crash-reporter.md) + +# GeckoCrashReporter + +`typealias GeckoCrashReporter = `[`CrashReporter`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/CrashReporter.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/service/MozillaSocorroService.kt#L12) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.crash.service/-mozilla-socorro-service/-init-.md b/docs/api/mozilla.components.lib.crash.service/-mozilla-socorro-service/-init-.md new file mode 100644 index 00000000000..f496414ce76 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.service/-mozilla-socorro-service/-init-.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.service](../index.md) / [MozillaSocorroService](index.md) / [<init>](./-init-.md) + +# <init> + +`MozillaSocorroService(applicationContext: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, appName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +A [CrashReporterService](../-crash-reporter-service/index.md) implementation uploading crash reports to crash-stats.mozilla.com. + +### Parameters + +`applicationContext` - The application [Context](https://developer.android.com/reference/android/content/Context.html). + +`appName` - A human-readable app name. This name is used on crash-stats.mozilla.com to filter crashes by app. + The name needs to be whitelisted for the server to accept the crash. + [File a bug](https://bugzilla.mozilla.org/enter_bug.cgi?product=Socorro) if you would like to get your + app added to the whitelist. \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.crash.service/-mozilla-socorro-service/index.md b/docs/api/mozilla.components.lib.crash.service/-mozilla-socorro-service/index.md new file mode 100644 index 00000000000..2944fc226fb --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.service/-mozilla-socorro-service/index.md @@ -0,0 +1,28 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.service](../index.md) / [MozillaSocorroService](./index.md) + +# MozillaSocorroService + +`class MozillaSocorroService : `[`CrashReporterService`](../-crash-reporter-service/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/service/MozillaSocorroService.kt#L23) + +A [CrashReporterService](../-crash-reporter-service/index.md) implementation uploading crash reports to crash-stats.mozilla.com. + +### Parameters + +`applicationContext` - The application [Context](https://developer.android.com/reference/android/content/Context.html). + +`appName` - A human-readable app name. This name is used on crash-stats.mozilla.com to filter crashes by app. + The name needs to be whitelisted for the server to accept the crash. + [File a bug](https://bugzilla.mozilla.org/enter_bug.cgi?product=Socorro) if you would like to get your + app added to the whitelist. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `MozillaSocorroService(applicationContext: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, appName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
A [CrashReporterService](../-crash-reporter-service/index.md) implementation uploading crash reports to crash-stats.mozilla.com. | + +### Functions + +| Name | Summary | +|---|---| +| [report](report.md) | `fun report(crash: `[`UncaughtExceptionCrash`](../../mozilla.components.lib.crash/-crash/-uncaught-exception-crash/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Submits a crash report for this [Crash.UncaughtExceptionCrash](../../mozilla.components.lib.crash/-crash/-uncaught-exception-crash/index.md).`fun report(crash: `[`NativeCodeCrash`](../../mozilla.components.lib.crash/-crash/-native-code-crash/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Submits a crash report for this [Crash.NativeCodeCrash](../../mozilla.components.lib.crash/-crash/-native-code-crash/index.md). | diff --git a/docs/api/mozilla.components.lib.crash.service/-mozilla-socorro-service/report.md b/docs/api/mozilla.components.lib.crash.service/-mozilla-socorro-service/report.md new file mode 100644 index 00000000000..a6b3afa54d9 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.service/-mozilla-socorro-service/report.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.service](../index.md) / [MozillaSocorroService](index.md) / [report](./report.md) + +# report + +`fun report(crash: `[`UncaughtExceptionCrash`](../../mozilla.components.lib.crash/-crash/-uncaught-exception-crash/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/service/MozillaSocorroService.kt#L27) + +Overrides [CrashReporterService.report](../-crash-reporter-service/report.md) + +Submits a crash report for this [Crash.UncaughtExceptionCrash](../../mozilla.components.lib.crash/-crash/-uncaught-exception-crash/index.md). + +`fun report(crash: `[`NativeCodeCrash`](../../mozilla.components.lib.crash/-crash/-native-code-crash/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/service/MozillaSocorroService.kt#L34) + +Overrides [CrashReporterService.report](../-crash-reporter-service/report.md) + +Submits a crash report for this [Crash.NativeCodeCrash](../../mozilla.components.lib.crash/-crash/-native-code-crash/index.md). + diff --git a/docs/api/mozilla.components.lib.crash.service/-sentry-service/-init-.md b/docs/api/mozilla.components.lib.crash.service/-sentry-service/-init-.md new file mode 100644 index 00000000000..7a58c88689b --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.service/-sentry-service/-init-.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.service](../index.md) / [SentryService](index.md) / [<init>](./-init-.md) + +# <init> + +`SentryService(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, dsn: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, tags: `[`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)`> = emptyMap(), sendEventForNativeCrashes: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, clientFactory: SentryClientFactory = AndroidSentryClientFactory(context))` + +A [CrashReporterService](../-crash-reporter-service/index.md) implementation that uploads crash reports to a Sentry server. + +### Parameters + +`context` - The application [Context](https://developer.android.com/reference/android/content/Context.html). + +`dsn` - Data Source Name of the Sentry server. + +`tags` - A list of additional tags that will be sent together with crash reports. \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.crash.service/-sentry-service/index.md b/docs/api/mozilla.components.lib.crash.service/-sentry-service/index.md new file mode 100644 index 00000000000..7c5622570bd --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.service/-sentry-service/index.md @@ -0,0 +1,27 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.service](../index.md) / [SentryService](./index.md) + +# SentryService + +`class SentryService : `[`CrashReporterService`](../-crash-reporter-service/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/service/SentryService.kt#L21) + +A [CrashReporterService](../-crash-reporter-service/index.md) implementation that uploads crash reports to a Sentry server. + +### Parameters + +`context` - The application [Context](https://developer.android.com/reference/android/content/Context.html). + +`dsn` - Data Source Name of the Sentry server. + +`tags` - A list of additional tags that will be sent together with crash reports. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SentryService(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, dsn: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, tags: `[`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)`> = emptyMap(), sendEventForNativeCrashes: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, clientFactory: SentryClientFactory = AndroidSentryClientFactory(context))`
A [CrashReporterService](../-crash-reporter-service/index.md) implementation that uploads crash reports to a Sentry server. | + +### Functions + +| Name | Summary | +|---|---| +| [report](report.md) | `fun report(crash: `[`UncaughtExceptionCrash`](../../mozilla.components.lib.crash/-crash/-uncaught-exception-crash/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Submits a crash report for this [Crash.UncaughtExceptionCrash](../../mozilla.components.lib.crash/-crash/-uncaught-exception-crash/index.md).`fun report(crash: `[`NativeCodeCrash`](../../mozilla.components.lib.crash/-crash/-native-code-crash/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Submits a crash report for this [Crash.NativeCodeCrash](../../mozilla.components.lib.crash/-crash/-native-code-crash/index.md). | diff --git a/docs/api/mozilla.components.lib.crash.service/-sentry-service/report.md b/docs/api/mozilla.components.lib.crash.service/-sentry-service/report.md new file mode 100644 index 00000000000..e60a296777c --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.service/-sentry-service/report.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash.service](../index.md) / [SentryService](index.md) / [report](./report.md) + +# report + +`fun report(crash: `[`UncaughtExceptionCrash`](../../mozilla.components.lib.crash/-crash/-uncaught-exception-crash/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/service/SentryService.kt#L39) + +Overrides [CrashReporterService.report](../-crash-reporter-service/report.md) + +Submits a crash report for this [Crash.UncaughtExceptionCrash](../../mozilla.components.lib.crash/-crash/-uncaught-exception-crash/index.md). + +`fun report(crash: `[`NativeCodeCrash`](../../mozilla.components.lib.crash/-crash/-native-code-crash/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/service/SentryService.kt#L43) + +Overrides [CrashReporterService.report](../-crash-reporter-service/report.md) + +Submits a crash report for this [Crash.NativeCodeCrash](../../mozilla.components.lib.crash/-crash/-native-code-crash/index.md). + diff --git a/docs/api/mozilla.components.lib.crash.service/index.md b/docs/api/mozilla.components.lib.crash.service/index.md new file mode 100644 index 00000000000..0fee60e2ef8 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash.service/index.md @@ -0,0 +1,17 @@ +[android-components](../index.md) / [mozilla.components.lib.crash.service](./index.md) + +## Package mozilla.components.lib.crash.service + +### Types + +| Name | Summary | +|---|---| +| [CrashReporterService](-crash-reporter-service/index.md) | `interface CrashReporterService`
Interface to be implemented by external services that accept crash reports. | +| [MozillaSocorroService](-mozilla-socorro-service/index.md) | `class MozillaSocorroService : `[`CrashReporterService`](-crash-reporter-service/index.md)
A [CrashReporterService](-crash-reporter-service/index.md) implementation uploading crash reports to crash-stats.mozilla.com. | +| [SentryService](-sentry-service/index.md) | `class SentryService : `[`CrashReporterService`](-crash-reporter-service/index.md)
A [CrashReporterService](-crash-reporter-service/index.md) implementation that uploads crash reports to a Sentry server. | + +### Type Aliases + +| Name | Summary | +|---|---| +| [GeckoCrashReporter](-gecko-crash-reporter.md) | `typealias GeckoCrashReporter = `[`CrashReporter`](https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/CrashReporter.html) | diff --git a/docs/api/mozilla.components.lib.crash/-crash-reporter/-init-.md b/docs/api/mozilla.components.lib.crash/-crash-reporter/-init-.md new file mode 100644 index 00000000000..16412d541c4 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash-reporter/-init-.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash](../index.md) / [CrashReporter](index.md) / [<init>](./-init-.md) + +# <init> + +`CrashReporter(services: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`CrashReporterService`](../../mozilla.components.lib.crash.service/-crash-reporter-service/index.md)`>, shouldPrompt: `[`Prompt`](-prompt/index.md)` = Prompt.NEVER, enabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, promptConfiguration: `[`PromptConfiguration`](-prompt-configuration/index.md)` = PromptConfiguration(), nonFatalCrashIntent: `[`PendingIntent`](https://developer.android.com/reference/android/app/PendingIntent.html)`? = null)` + +A generic crash reporter that can report crashes to multiple services. + +In the `onCreate()` method of your Application class create a `CrashReporter` instance and call `install()`: + +``` Kotlin +CrashReporter( + services = listOf( + // List the crash reporting services you want to use + ) +).install(this) +``` + +With this minimal setup the crash reporting library will capture "uncaught exception" crashes and "native code" +crashes and forward them to the configured crash reporting services. + diff --git a/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt-configuration/-init-.md b/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt-configuration/-init-.md new file mode 100644 index 00000000000..42a306e1b26 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt-configuration/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.lib.crash](../../index.md) / [CrashReporter](../index.md) / [PromptConfiguration](index.md) / [<init>](./-init-.md) + +# <init> + +`PromptConfiguration(appName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "App", organizationName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "Mozilla", message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, @StyleRes theme: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = R.style.Theme_Mozac_CrashReporter)` + +Configuration for the crash reporter prompt. + diff --git a/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt-configuration/index.md b/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt-configuration/index.md new file mode 100644 index 00000000000..4f3561dc4db --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt-configuration/index.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.lib.crash](../../index.md) / [CrashReporter](../index.md) / [PromptConfiguration](./index.md) + +# PromptConfiguration + +`data class PromptConfiguration` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/CrashReporter.kt#L156) + +Configuration for the crash reporter prompt. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `PromptConfiguration(appName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "App", organizationName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "Mozilla", message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, theme: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = R.style.Theme_Mozac_CrashReporter)`
Configuration for the crash reporter prompt. | diff --git a/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt/-a-l-w-a-y-s.md b/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt/-a-l-w-a-y-s.md new file mode 100644 index 00000000000..1366bd3ffaa --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt/-a-l-w-a-y-s.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.lib.crash](../../index.md) / [CrashReporter](../index.md) / [Prompt](index.md) / [ALWAYS](./-a-l-w-a-y-s.md) + +# ALWAYS + +`ALWAYS` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/CrashReporter.kt#L150) + +Always prompt the user for confirmation before sending crash reports. + diff --git a/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt/-n-e-v-e-r.md b/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt/-n-e-v-e-r.md new file mode 100644 index 00000000000..f8ebb4f5fb7 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt/-n-e-v-e-r.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.lib.crash](../../index.md) / [CrashReporter](../index.md) / [Prompt](index.md) / [NEVER](./-n-e-v-e-r.md) + +# NEVER + +`NEVER` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/CrashReporter.kt#L140) + +Never prompt the user. Always submit crash reports immediately. + diff --git a/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt/-o-n-l-y_-n-a-t-i-v-e_-c-r-a-s-h.md b/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt/-o-n-l-y_-n-a-t-i-v-e_-c-r-a-s-h.md new file mode 100644 index 00000000000..190cbdb5319 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt/-o-n-l-y_-n-a-t-i-v-e_-c-r-a-s-h.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.lib.crash](../../index.md) / [CrashReporter](../index.md) / [Prompt](index.md) / [ONLY_NATIVE_CRASH](./-o-n-l-y_-n-a-t-i-v-e_-c-r-a-s-h.md) + +# ONLY_NATIVE_CRASH + +`ONLY_NATIVE_CRASH` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/CrashReporter.kt#L145) + +Only prompt the user for native code crashes. + diff --git a/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt/index.md b/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt/index.md new file mode 100644 index 00000000000..5daf56562b7 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash-reporter/-prompt/index.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.lib.crash](../../index.md) / [CrashReporter](../index.md) / [Prompt](./index.md) + +# Prompt + +`enum class Prompt` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/CrashReporter.kt#L136) + +### Enum Values + +| Name | Summary | +|---|---| +| [NEVER](-n-e-v-e-r.md) | Never prompt the user. Always submit crash reports immediately. | +| [ONLY_NATIVE_CRASH](-o-n-l-y_-n-a-t-i-v-e_-c-r-a-s-h.md) | Only prompt the user for native code crashes. | +| [ALWAYS](-a-l-w-a-y-s.md) | Always prompt the user for confirmation before sending crash reports. | diff --git a/docs/api/mozilla.components.lib.crash/-crash-reporter/enabled.md b/docs/api/mozilla.components.lib.crash/-crash-reporter/enabled.md new file mode 100644 index 00000000000..7204e6b14e4 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash-reporter/enabled.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash](../index.md) / [CrashReporter](index.md) / [enabled](./enabled.md) + +# enabled + +`var enabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/CrashReporter.kt#L46) + +Enable/Disable crash reporting. + +### Property + +`enabled` - Enable/Disable crash reporting. + +### Parameters + +`services` - List of crash reporting services that should receive crash reports. + +`shouldPrompt` - Whether or not the user should be prompted to confirm sending crash reports. + +`enabled` - Enable/Disable crash reporting. + +`promptConfiguration` - Configuration for customizing the crash reporter prompt. + +`nonFatalCrashIntent` - A [PendingIntent](https://developer.android.com/reference/android/app/PendingIntent.html) that will be launched if a non fatal crash (main process not affected) + happened. This gives the app the opportunity to show an in-app confirmation UI before + sending a crash report. See component README for details. \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.crash/-crash-reporter/index.md b/docs/api/mozilla.components.lib.crash/-crash-reporter/index.md new file mode 100644 index 00000000000..3dd92a5f8dd --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash-reporter/index.md @@ -0,0 +1,46 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash](../index.md) / [CrashReporter](./index.md) + +# CrashReporter + +`class CrashReporter` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/CrashReporter.kt#L43) + +A generic crash reporter that can report crashes to multiple services. + +In the `onCreate()` method of your Application class create a `CrashReporter` instance and call `install()`: + +``` Kotlin +CrashReporter( + services = listOf( + // List the crash reporting services you want to use + ) +).install(this) +``` + +With this minimal setup the crash reporting library will capture "uncaught exception" crashes and "native code" +crashes and forward them to the configured crash reporting services. + +### Types + +| Name | Summary | +|---|---| +| [Prompt](-prompt/index.md) | `enum class Prompt` | +| [PromptConfiguration](-prompt-configuration/index.md) | `data class PromptConfiguration`
Configuration for the crash reporter prompt. | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `CrashReporter(services: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`CrashReporterService`](../../mozilla.components.lib.crash.service/-crash-reporter-service/index.md)`>, shouldPrompt: `[`Prompt`](-prompt/index.md)` = Prompt.NEVER, enabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true, promptConfiguration: `[`PromptConfiguration`](-prompt-configuration/index.md)` = PromptConfiguration(), nonFatalCrashIntent: `[`PendingIntent`](https://developer.android.com/reference/android/app/PendingIntent.html)`? = null)`
A generic crash reporter that can report crashes to multiple services. | + +### Properties + +| Name | Summary | +|---|---| +| [enabled](enabled.md) | `var enabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Enable/Disable crash reporting. | + +### Functions + +| Name | Summary | +|---|---| +| [install](install.md) | `fun install(applicationContext: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`CrashReporter`](./index.md)
Install this [CrashReporter](./index.md) instance. At this point the component will be setup to collect crash reports. | +| [submitReport](submit-report.md) | `fun submitReport(crash: `[`Crash`](../-crash/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Submit a crash report to all registered services. | diff --git a/docs/api/mozilla.components.lib.crash/-crash-reporter/install.md b/docs/api/mozilla.components.lib.crash/-crash-reporter/install.md new file mode 100644 index 00000000000..0a7c02f14f5 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash-reporter/install.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash](../index.md) / [CrashReporter](index.md) / [install](./install.md) + +# install + +`fun install(applicationContext: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`CrashReporter`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/CrashReporter.kt#L61) + +Install this [CrashReporter](index.md) instance. At this point the component will be setup to collect crash reports. + diff --git a/docs/api/mozilla.components.lib.crash/-crash-reporter/submit-report.md b/docs/api/mozilla.components.lib.crash/-crash-reporter/submit-report.md new file mode 100644 index 00000000000..cab4e65107e --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash-reporter/submit-report.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash](../index.md) / [CrashReporter](index.md) / [submitReport](./submit-report.md) + +# submitReport + +`fun submitReport(crash: `[`Crash`](../-crash/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/CrashReporter.kt#L76) + +Submit a crash report to all registered services. + +Note: This method may block and perform I/O on the calling thread. + diff --git a/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/-init-.md b/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/-init-.md new file mode 100644 index 00000000000..056592ffc06 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.lib.crash](../../index.md) / [Crash](../index.md) / [NativeCodeCrash](index.md) / [<init>](./-init-.md) + +# <init> + +`NativeCodeCrash(minidumpPath: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, minidumpSuccess: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, extrasPath: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, isFatal: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` + +A crash that happened in native code. + diff --git a/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/extras-path.md b/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/extras-path.md new file mode 100644 index 00000000000..5df2095862f --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/extras-path.md @@ -0,0 +1,15 @@ +[android-components](../../../index.md) / [mozilla.components.lib.crash](../../index.md) / [Crash](../index.md) / [NativeCodeCrash](index.md) / [extrasPath](./extras-path.md) + +# extrasPath + +`val extrasPath: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/Crash.kt#L62) + +Path to a file containing extra metadata about the crash. The file contains key-value pairs + in the form `Key=Value`. Be aware, it may contain sensitive data such as the URI that was + loaded at the time of the crash. + +### Property + +`extrasPath` - Path to a file containing extra metadata about the crash. The file contains key-value pairs + in the form `Key=Value`. Be aware, it may contain sensitive data such as the URI that was + loaded at the time of the crash. \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/index.md b/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/index.md new file mode 100644 index 00000000000..679a3940d39 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/index.md @@ -0,0 +1,22 @@ +[android-components](../../../index.md) / [mozilla.components.lib.crash](../../index.md) / [Crash](../index.md) / [NativeCodeCrash](./index.md) + +# NativeCodeCrash + +`data class NativeCodeCrash : `[`Crash`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/Crash.kt#L59) + +A crash that happened in native code. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `NativeCodeCrash(minidumpPath: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, minidumpSuccess: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, extrasPath: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, isFatal: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)`
A crash that happened in native code. | + +### Properties + +| Name | Summary | +|---|---| +| [extrasPath](extras-path.md) | `val extrasPath: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Path to a file containing extra metadata about the crash. The file contains key-value pairs in the form `Key=Value`. Be aware, it may contain sensitive data such as the URI that was loaded at the time of the crash. | +| [isFatal](is-fatal.md) | `val isFatal: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Whether or not the crash was fatal or not: If true, the main application process was affected by the crash. If false, only an internal process used by Gecko has crashed and the application may be able to recover. | +| [minidumpPath](minidump-path.md) | `val minidumpPath: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Path to a Breakpad minidump file containing information about the crash. | +| [minidumpSuccess](minidump-success.md) | `val minidumpSuccess: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicating whether or not the crash dump was successfully retrieved. If this is false, the dump file may be corrupted or incomplete. | diff --git a/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/is-fatal.md b/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/is-fatal.md new file mode 100644 index 00000000000..2ed741ab8d1 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/is-fatal.md @@ -0,0 +1,15 @@ +[android-components](../../../index.md) / [mozilla.components.lib.crash](../../index.md) / [Crash](../index.md) / [NativeCodeCrash](index.md) / [isFatal](./is-fatal.md) + +# isFatal + +`val isFatal: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/Crash.kt#L63) + +Whether or not the crash was fatal or not: If true, the main application process was affected + by the crash. If false, only an internal process used by Gecko has crashed and the application + may be able to recover. + +### Property + +`isFatal` - Whether or not the crash was fatal or not: If true, the main application process was affected + by the crash. If false, only an internal process used by Gecko has crashed and the application + may be able to recover. \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/minidump-path.md b/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/minidump-path.md new file mode 100644 index 00000000000..1f7fc11c3f7 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/minidump-path.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.lib.crash](../../index.md) / [Crash](../index.md) / [NativeCodeCrash](index.md) / [minidumpPath](./minidump-path.md) + +# minidumpPath + +`val minidumpPath: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/Crash.kt#L60) + +Path to a Breakpad minidump file containing information about the crash. + +### Property + +`minidumpPath` - Path to a Breakpad minidump file containing information about the crash. \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/minidump-success.md b/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/minidump-success.md new file mode 100644 index 00000000000..916f747d595 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash/-native-code-crash/minidump-success.md @@ -0,0 +1,13 @@ +[android-components](../../../index.md) / [mozilla.components.lib.crash](../../index.md) / [Crash](../index.md) / [NativeCodeCrash](index.md) / [minidumpSuccess](./minidump-success.md) + +# minidumpSuccess + +`val minidumpSuccess: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/Crash.kt#L61) + +Indicating whether or not the crash dump was successfully retrieved. If this is false, + the dump file may be corrupted or incomplete. + +### Property + +`minidumpSuccess` - Indicating whether or not the crash dump was successfully retrieved. If this is false, + the dump file may be corrupted or incomplete. \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.crash/-crash/-uncaught-exception-crash/-init-.md b/docs/api/mozilla.components.lib.crash/-crash/-uncaught-exception-crash/-init-.md new file mode 100644 index 00000000000..cf154d8642d --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash/-uncaught-exception-crash/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.lib.crash](../../index.md) / [Crash](../index.md) / [UncaughtExceptionCrash](index.md) / [<init>](./-init-.md) + +# <init> + +`UncaughtExceptionCrash(throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`)` + +A crash caused by an uncaught exception. + diff --git a/docs/api/mozilla.components.lib.crash/-crash/-uncaught-exception-crash/index.md b/docs/api/mozilla.components.lib.crash/-crash/-uncaught-exception-crash/index.md new file mode 100644 index 00000000000..4e97edc5cc8 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash/-uncaught-exception-crash/index.md @@ -0,0 +1,19 @@ +[android-components](../../../index.md) / [mozilla.components.lib.crash](../../index.md) / [Crash](../index.md) / [UncaughtExceptionCrash](./index.md) + +# UncaughtExceptionCrash + +`data class UncaughtExceptionCrash : `[`Crash`](../index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/Crash.kt#L32) + +A crash caused by an uncaught exception. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `UncaughtExceptionCrash(throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`)`
A crash caused by an uncaught exception. | + +### Properties + +| Name | Summary | +|---|---| +| [throwable](throwable.md) | `val throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)
The [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) that caused the crash. | diff --git a/docs/api/mozilla.components.lib.crash/-crash/-uncaught-exception-crash/throwable.md b/docs/api/mozilla.components.lib.crash/-crash/-uncaught-exception-crash/throwable.md new file mode 100644 index 00000000000..5579001ea47 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash/-uncaught-exception-crash/throwable.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [mozilla.components.lib.crash](../../index.md) / [Crash](../index.md) / [UncaughtExceptionCrash](index.md) / [throwable](./throwable.md) + +# throwable + +`val throwable: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/Crash.kt#L33) + +The [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) that caused the crash. + +### Property + +`throwable` - The [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) that caused the crash. \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.crash/-crash/from-intent.md b/docs/api/mozilla.components.lib.crash/-crash/from-intent.md new file mode 100644 index 00000000000..5474dfff5c4 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash/from-intent.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash](../index.md) / [Crash](index.md) / [fromIntent](./from-intent.md) + +# fromIntent + +`fun fromIntent(intent: `[`Intent`](https://developer.android.com/reference/android/content/Intent.html)`): `[`Crash`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/Crash.kt#L89) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.crash/-crash/index.md b/docs/api/mozilla.components.lib.crash/-crash/index.md new file mode 100644 index 00000000000..86fc2e7c7cb --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash/index.md @@ -0,0 +1,28 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash](../index.md) / [Crash](./index.md) + +# Crash + +`sealed class Crash` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/Crash.kt#L26) + +Crash types that are handled by this library. + +### Types + +| Name | Summary | +|---|---| +| [NativeCodeCrash](-native-code-crash/index.md) | `data class NativeCodeCrash : `[`Crash`](./index.md)
A crash that happened in native code. | +| [UncaughtExceptionCrash](-uncaught-exception-crash/index.md) | `data class UncaughtExceptionCrash : `[`Crash`](./index.md)
A crash caused by an uncaught exception. | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [fromIntent](from-intent.md) | `fun fromIntent(intent: `[`Intent`](https://developer.android.com/reference/android/content/Intent.html)`): `[`Crash`](./index.md) | +| [isCrashIntent](is-crash-intent.md) | `fun isCrashIntent(intent: `[`Intent`](https://developer.android.com/reference/android/content/Intent.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [NativeCodeCrash](-native-code-crash/index.md) | `data class NativeCodeCrash : `[`Crash`](./index.md)
A crash that happened in native code. | +| [UncaughtExceptionCrash](-uncaught-exception-crash/index.md) | `data class UncaughtExceptionCrash : `[`Crash`](./index.md)
A crash caused by an uncaught exception. | diff --git a/docs/api/mozilla.components.lib.crash/-crash/is-crash-intent.md b/docs/api/mozilla.components.lib.crash/-crash/is-crash-intent.md new file mode 100644 index 00000000000..7345f63acd1 --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/-crash/is-crash-intent.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.crash](../index.md) / [Crash](index.md) / [isCrashIntent](./is-crash-intent.md) + +# isCrashIntent + +`fun isCrashIntent(intent: `[`Intent`](https://developer.android.com/reference/android/content/Intent.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/crash/src/main/java/mozilla/components/lib/crash/Crash.kt#L99) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.crash/index.md b/docs/api/mozilla.components.lib.crash/index.md new file mode 100644 index 00000000000..e835f7ade0c --- /dev/null +++ b/docs/api/mozilla.components.lib.crash/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.lib.crash](./index.md) + +## Package mozilla.components.lib.crash + +### Types + +| Name | Summary | +|---|---| +| [Crash](-crash/index.md) | `sealed class Crash`
Crash types that are handled by this library. | +| [CrashReporter](-crash-reporter/index.md) | `class CrashReporter`
A generic crash reporter that can report crashes to multiple services. | diff --git a/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/-init-.md b/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/-init-.md new file mode 100644 index 00000000000..5fb34f97db8 --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [KeyStoreWrapper](index.md) / [<init>](./-init-.md) + +# <init> + +`KeyStoreWrapper()` + +Wraps the critical functions around a Java KeyStore to better facilitate testing +and instrumenting. + diff --git a/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/get-key-for.md b/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/get-key-for.md new file mode 100644 index 00000000000..cc428c4b3b6 --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/get-key-for.md @@ -0,0 +1,28 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [KeyStoreWrapper](index.md) / [getKeyFor](./get-key-for.md) + +# getKeyFor + +`open fun getKeyFor(label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Key`](https://developer.android.com/reference/java/security/Key.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/dataprotect/src/main/java/mozilla/components/lib/dataprotect/Keystore.kt#L68) + +Retrieves the SecretKey for the given label. + +This method queries for a SecretKey with the given label and no passphrase. + +Subclasses override this method if additional properties are needed +to retrieve the key. + +### Parameters + +`label` - The label to query + +### Exceptions + +`InvalidKeyException` - If there is a Key but it is not a SecretKey + +`NoSuchAlgorithmException` - If the recovery algorithm is not supported + +`UnrecoverableKeyException` - If the key could not be recovered for some reason + +**Return** +The key for the given label, or `null` if not present + diff --git a/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/get-key-store.md b/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/get-key-store.md new file mode 100644 index 00000000000..1bda1ba0ff6 --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/get-key-store.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [KeyStoreWrapper](index.md) / [getKeyStore](./get-key-store.md) + +# getKeyStore + +`fun getKeyStore(): `[`KeyStore`](https://developer.android.com/reference/java/security/KeyStore.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/dataprotect/src/main/java/mozilla/components/lib/dataprotect/Keystore.kt#L44) + +Retrieves the underlying KeyStore, loading it if necessary. + diff --git a/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/index.md b/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/index.md new file mode 100644 index 00000000000..2a4666425b3 --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/index.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [KeyStoreWrapper](./index.md) + +# KeyStoreWrapper + +`open class KeyStoreWrapper` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/dataprotect/src/main/java/mozilla/components/lib/dataprotect/Keystore.kt#L38) + +Wraps the critical functions around a Java KeyStore to better facilitate testing +and instrumenting. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `KeyStoreWrapper()`
Wraps the critical functions around a Java KeyStore to better facilitate testing and instrumenting. | + +### Functions + +| Name | Summary | +|---|---| +| [getKeyFor](get-key-for.md) | `open fun getKeyFor(label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Key`](https://developer.android.com/reference/java/security/Key.html)`?`
Retrieves the SecretKey for the given label. | +| [getKeyStore](get-key-store.md) | `fun getKeyStore(): `[`KeyStore`](https://developer.android.com/reference/java/security/KeyStore.html)
Retrieves the underlying KeyStore, loading it if necessary. | +| [loadKeyStore](load-key-store.md) | `open fun loadKeyStore(): `[`KeyStore`](https://developer.android.com/reference/java/security/KeyStore.html)
Creates and initializes the KeyStore in use. | +| [makeKeyFor](make-key-for.md) | `open fun makeKeyFor(label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`SecretKey`](https://developer.android.com/reference/javax/crypto/SecretKey.html)
Creates a SecretKey for the given label. | +| [removeKeyFor](remove-key-for.md) | `fun removeKeyFor(label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Deletes a key with the given label. | diff --git a/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/load-key-store.md b/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/load-key-store.md new file mode 100644 index 00000000000..6cba49ce89b --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/load-key-store.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [KeyStoreWrapper](index.md) / [loadKeyStore](./load-key-store.md) + +# loadKeyStore + +`open fun loadKeyStore(): `[`KeyStore`](https://developer.android.com/reference/java/security/KeyStore.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/dataprotect/src/main/java/mozilla/components/lib/dataprotect/Keystore.kt#L116) + +Creates and initializes the KeyStore in use. + +This method loads a`"AndroidKeyStore"` type KeyStore. + +Subclasses override this to load a KeyStore appropriate to the testing environment. + +### Exceptions + +`KeyStoreException` - if the type of store is not supported + +**Return** +The KeyStore, already initialized + diff --git a/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/make-key-for.md b/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/make-key-for.md new file mode 100644 index 00000000000..d404ba1125f --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/make-key-for.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [KeyStoreWrapper](index.md) / [makeKeyFor](./make-key-for.md) + +# makeKeyFor + +`open fun makeKeyFor(label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`SecretKey`](https://developer.android.com/reference/javax/crypto/SecretKey.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/dataprotect/src/main/java/mozilla/components/lib/dataprotect/Keystore.kt#L84) + +Creates a SecretKey for the given label. + +This method generates a SecretKey pre-bound to the `AndroidKeyStore` and configured +with the strongest "algorithm/blockmode/padding" (and key size) available. + +Subclasses override this method to properly associate the generated key with +the given label in the underlying KeyStore. + +### Parameters + +`label` - The label to associate with the created key + +### Exceptions + +`NoSuchAlgorithmException` - If the cipher algorithm is not supported + +**Return** +The newly-generated key for `label` + diff --git a/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/remove-key-for.md b/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/remove-key-for.md new file mode 100644 index 00000000000..fdfe0f25de7 --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-key-store-wrapper/remove-key-for.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [KeyStoreWrapper](index.md) / [removeKeyFor](./remove-key-for.md) + +# removeKeyFor + +`fun removeKeyFor(label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/dataprotect/src/main/java/mozilla/components/lib/dataprotect/Keystore.kt#L102) + +Deletes a key with the given label. + +### Parameters + +`label` - The label of the associated key to delete + +### Exceptions + +`KeyStoreException` - If there is no key for `label` \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.dataprotect/-keystore-exception/-init-.md b/docs/api/mozilla.components.lib.dataprotect/-keystore-exception/-init-.md new file mode 100644 index 00000000000..1da221a3908 --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-keystore-exception/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [KeystoreException](index.md) / [<init>](./-init-.md) + +# <init> + +`KeystoreException(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, cause: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null)` + +Exception type thrown by {@link Keystore} when an error is encountered that +is not otherwise covered by an existing sub-class to `GeneralSecurityException`. + diff --git a/docs/api/mozilla.components.lib.dataprotect/-keystore-exception/index.md b/docs/api/mozilla.components.lib.dataprotect/-keystore-exception/index.md new file mode 100644 index 00000000000..e309639c20a --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-keystore-exception/index.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [KeystoreException](./index.md) + +# KeystoreException + +`class KeystoreException : `[`GeneralSecurityException`](https://developer.android.com/reference/java/security/GeneralSecurityException.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/dataprotect/src/main/java/mozilla/components/lib/dataprotect/KeystoreException.kt#L14) + +Exception type thrown by {@link Keystore} when an error is encountered that +is not otherwise covered by an existing sub-class to `GeneralSecurityException`. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `KeystoreException(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, cause: `[`Throwable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)`? = null)`
Exception type thrown by {@link Keystore} when an error is encountered that is not otherwise covered by an existing sub-class to `GeneralSecurityException`. | diff --git a/docs/api/mozilla.components.lib.dataprotect/-keystore/-init-.md b/docs/api/mozilla.components.lib.dataprotect/-keystore/-init-.md new file mode 100644 index 00000000000..66cb1a1ce97 --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-keystore/-init-.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [Keystore](index.md) / [<init>](./-init-.md) + +# <init> + +`Keystore(label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, manual: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, wrapper: `[`KeyStoreWrapper`](../-key-store-wrapper/index.md)` = KeyStoreWrapper())` + +Creates a new instance around a key identified by the given label + +Unless `manual` is `true`, the key is created if not already present in the +platform's key storage. + +**Constructor** + +Creates a new instance around a key identified by the given label + + + +Unless `manual` is `true`, the key is created if not already present in the +platform's key storage. + diff --git a/docs/api/mozilla.components.lib.dataprotect/-keystore/available.md b/docs/api/mozilla.components.lib.dataprotect/-keystore/available.md new file mode 100644 index 00000000000..c1267b799b9 --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-keystore/available.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [Keystore](index.md) / [available](./available.md) + +# available + +`fun available(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/dataprotect/src/main/java/mozilla/components/lib/dataprotect/Keystore.kt#L163) + +Determines if the managed key is available for use. Consumers can use this to +determine if the key was somehow lost and should treat any previously-protected +data as invalid. + +**Return** +`true` if the managed key exists and ready for use. + diff --git a/docs/api/mozilla.components.lib.dataprotect/-keystore/create-decrypt-cipher.md b/docs/api/mozilla.components.lib.dataprotect/-keystore/create-decrypt-cipher.md new file mode 100644 index 00000000000..b313100d066 --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-keystore/create-decrypt-cipher.md @@ -0,0 +1,26 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [Keystore](index.md) / [createDecryptCipher](./create-decrypt-cipher.md) + +# createDecryptCipher + +`open fun createDecryptCipher(iv: `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`): `[`Cipher`](https://developer.android.com/reference/javax/crypto/Cipher.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/dataprotect/src/main/java/mozilla/components/lib/dataprotect/Keystore.kt#L284) + +Create a cipher initialized for decrypting data with the managed key. + +This "low-level" method is useful when a cryptographic context is needed to integrate with +other APIs, such as the `FingerprintManager`. + +**NOTE:** The caller is responsible for associating certain encryption factors, such as +the initialization vector and/or additional authentication data (AAD), with the stored +ciphertext or decryption will fail. + +### Parameters + +`iv` - The initialization vector/nonce to decrypt with + +### Exceptions + +`GeneralSecurityException` - If the cipher could not be created and initialized + +**Return** +The [Cipher](https://developer.android.com/reference/javax/crypto/Cipher.html), initialized and ready to decrypt data with. + diff --git a/docs/api/mozilla.components.lib.dataprotect/-keystore/create-encrypt-cipher.md b/docs/api/mozilla.components.lib.dataprotect/-keystore/create-encrypt-cipher.md new file mode 100644 index 00000000000..b6b081399e6 --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-keystore/create-encrypt-cipher.md @@ -0,0 +1,22 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [Keystore](index.md) / [createEncryptCipher](./create-encrypt-cipher.md) + +# createEncryptCipher + +`open fun createEncryptCipher(): `[`Cipher`](https://developer.android.com/reference/javax/crypto/Cipher.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/dataprotect/src/main/java/mozilla/components/lib/dataprotect/Keystore.kt#L261) + +Create a cipher initialized for encrypting data with the managed key. + +This "low-level" method is useful when a cryptographic context is needed to integrate with +other APIs, such as the `FingerprintManager`. + +**NOTE:** The caller is responsible for associating certain encryption factors, such as +the initialization vector and/or additional authentication data (AAD), with the resulting +ciphertext or decryption will fail. + +### Exceptions + +`GeneralSecurityException` - If the Cipher could not be created and initialized + +**Return** +The [Cipher](https://developer.android.com/reference/javax/crypto/Cipher.html), initialized and ready to encrypt data with. + diff --git a/docs/api/mozilla.components.lib.dataprotect/-keystore/decrypt-bytes.md b/docs/api/mozilla.components.lib.dataprotect/-keystore/decrypt-bytes.md new file mode 100644 index 00000000000..4e603092737 --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-keystore/decrypt-bytes.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [Keystore](index.md) / [decryptBytes](./decrypt-bytes.md) + +# decryptBytes + +`open fun decryptBytes(encrypted: `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`): `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/dataprotect/src/main/java/mozilla/components/lib/dataprotect/Keystore.kt#L235) + +Decrypts data using the managed key. + +The input of this method is expected to include input factors (i.e., initialization +vector), ciphertext, and authentication tag as a single byte string; it is the direct +output from [encryptBytes](encrypt-bytes.md). + +### Parameters + +`encrypted` - The encrypted data to decrypt + +### Exceptions + +`KeystoreException` - If the data could not be decrypted + +**Return** +The decrypted "plaintext" data + diff --git a/docs/api/mozilla.components.lib.dataprotect/-keystore/delete-key.md b/docs/api/mozilla.components.lib.dataprotect/-keystore/delete-key.md new file mode 100644 index 00000000000..a0109cbfce0 --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-keystore/delete-key.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [Keystore](index.md) / [deleteKey](./delete-key.md) + +# deleteKey + +`fun deleteKey(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/dataprotect/src/main/java/mozilla/components/lib/dataprotect/Keystore.kt#L193) + +Deletes the managed key. + +**NOTE:** Once this method returns, any data protected with the (formerly) managed +key cannot be decrypted and therefore is inaccessble. + diff --git a/docs/api/mozilla.components.lib.dataprotect/-keystore/encrypt-bytes.md b/docs/api/mozilla.components.lib.dataprotect/-keystore/encrypt-bytes.md new file mode 100644 index 00000000000..6f9d6f967a6 --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-keystore/encrypt-bytes.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [Keystore](index.md) / [encryptBytes](./encrypt-bytes.md) + +# encryptBytes + +`open fun encryptBytes(plain: `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`): `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/dataprotect/src/main/java/mozilla/components/lib/dataprotect/Keystore.kt#L212) + +Encrypts data using the managed key. + +The output of this method includes the input factors (i.e., initialization vector), +ciphertext, and authentication tag as a single byte string; this output can be passed +directly to [decryptBytes](decrypt-bytes.md). + +### Parameters + +`plain` - The "plaintext" data to encrypt + +### Exceptions + +`GeneralSecurityException` - If the data could not be encrypted + +**Return** +The encrypted data to be stored + diff --git a/docs/api/mozilla.components.lib.dataprotect/-keystore/generate-key.md b/docs/api/mozilla.components.lib.dataprotect/-keystore/generate-key.md new file mode 100644 index 00000000000..3ad11b1f44b --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-keystore/generate-key.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [Keystore](index.md) / [generateKey](./generate-key.md) + +# generateKey + +`fun generateKey(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/dataprotect/src/main/java/mozilla/components/lib/dataprotect/Keystore.kt#L173) + +Generates the managed key if it does not already exist. + +### Exceptions + +`GeneralSecurityException` - If the key could not be created + +**Return** +`true` if a new key was generated; `false` if the key already exists and can +be used. + diff --git a/docs/api/mozilla.components.lib.dataprotect/-keystore/index.md b/docs/api/mozilla.components.lib.dataprotect/-keystore/index.md new file mode 100644 index 00000000000..f81a059024e --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-keystore/index.md @@ -0,0 +1,42 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [Keystore](./index.md) + +# Keystore + +`open class Keystore` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/dataprotect/src/main/java/mozilla/components/lib/dataprotect/Keystore.kt#L142) + +Manages data protection using a system-isolated cryptographic key. + +This class provides for both: + +* management for a specific crypto graphic key (identified by a string label) +* protection (encryption/decryption) of data using the managed key + +The specific cryptographic properties are pre-chosen to be the following: + +* Algorithm is "AES/GCM/NoPadding" +* Key size is 256 bits +* Tag size is 128 bits + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Keystore(label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, manual: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, wrapper: `[`KeyStoreWrapper`](../-key-store-wrapper/index.md)` = KeyStoreWrapper())`
Creates a new instance around a key identified by the given label | + +### Properties + +| Name | Summary | +|---|---| +| [label](label.md) | `val label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The label the cryptographic key is identified as | + +### Functions + +| Name | Summary | +|---|---| +| [available](available.md) | `fun available(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determines if the managed key is available for use. Consumers can use this to determine if the key was somehow lost and should treat any previously-protected data as invalid. | +| [createDecryptCipher](create-decrypt-cipher.md) | `open fun createDecryptCipher(iv: `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`): `[`Cipher`](https://developer.android.com/reference/javax/crypto/Cipher.html)
Create a cipher initialized for decrypting data with the managed key. | +| [createEncryptCipher](create-encrypt-cipher.md) | `open fun createEncryptCipher(): `[`Cipher`](https://developer.android.com/reference/javax/crypto/Cipher.html)
Create a cipher initialized for encrypting data with the managed key. | +| [decryptBytes](decrypt-bytes.md) | `open fun decryptBytes(encrypted: `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`): `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)
Decrypts data using the managed key. | +| [deleteKey](delete-key.md) | `fun deleteKey(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Deletes the managed key. | +| [encryptBytes](encrypt-bytes.md) | `open fun encryptBytes(plain: `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`): `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)
Encrypts data using the managed key. | +| [generateKey](generate-key.md) | `fun generateKey(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Generates the managed key if it does not already exist. | diff --git a/docs/api/mozilla.components.lib.dataprotect/-keystore/label.md b/docs/api/mozilla.components.lib.dataprotect/-keystore/label.md new file mode 100644 index 00000000000..2fba1ce5e76 --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/-keystore/label.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.lib.dataprotect](../index.md) / [Keystore](index.md) / [label](./label.md) + +# label + +`val label: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/dataprotect/src/main/java/mozilla/components/lib/dataprotect/Keystore.kt#L143) + +The label the cryptographic key is identified as + +### Property + +`label` - The label the cryptographic key is identified as \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.dataprotect/index.md b/docs/api/mozilla.components.lib.dataprotect/index.md new file mode 100644 index 00000000000..b6d9a426f35 --- /dev/null +++ b/docs/api/mozilla.components.lib.dataprotect/index.md @@ -0,0 +1,16 @@ +[android-components](../index.md) / [mozilla.components.lib.dataprotect](./index.md) + +## Package mozilla.components.lib.dataprotect + +### Types + +| Name | Summary | +|---|---| +| [KeyStoreWrapper](-key-store-wrapper/index.md) | `open class KeyStoreWrapper`
Wraps the critical functions around a Java KeyStore to better facilitate testing and instrumenting. | +| [Keystore](-keystore/index.md) | `open class Keystore`
Manages data protection using a system-isolated cryptographic key. | + +### Exceptions + +| Name | Summary | +|---|---| +| [KeystoreException](-keystore-exception/index.md) | `class KeystoreException : `[`GeneralSecurityException`](https://developer.android.com/reference/java/security/GeneralSecurityException.html)
Exception type thrown by {@link Keystore} when an error is encountered that is not otherwise covered by an existing sub-class to `GeneralSecurityException`. | diff --git a/docs/api/mozilla.components.lib.fetch.httpurlconnection/-http-u-r-l-connection-client/-init-.md b/docs/api/mozilla.components.lib.fetch.httpurlconnection/-http-u-r-l-connection-client/-init-.md new file mode 100644 index 00000000000..9e659b57f82 --- /dev/null +++ b/docs/api/mozilla.components.lib.fetch.httpurlconnection/-http-u-r-l-connection-client/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.fetch.httpurlconnection](../index.md) / [HttpURLConnectionClient](index.md) / [<init>](./-init-.md) + +# <init> + +`HttpURLConnectionClient()` + +[HttpURLConnection](https://developer.android.com/reference/java/net/HttpURLConnection.html) implementation of [Client](../../mozilla.components.concept.fetch/-client/index.md). + diff --git a/docs/api/mozilla.components.lib.fetch.httpurlconnection/-http-u-r-l-connection-client/fetch.md b/docs/api/mozilla.components.lib.fetch.httpurlconnection/-http-u-r-l-connection-client/fetch.md new file mode 100644 index 00000000000..f98f519b3b0 --- /dev/null +++ b/docs/api/mozilla.components.lib.fetch.httpurlconnection/-http-u-r-l-connection-client/fetch.md @@ -0,0 +1,35 @@ +[android-components](../../index.md) / [mozilla.components.lib.fetch.httpurlconnection](../index.md) / [HttpURLConnectionClient](index.md) / [fetch](./fetch.md) + +# fetch + +`fun fetch(request: `[`Request`](../../mozilla.components.concept.fetch/-request/index.md)`): `[`Response`](../../mozilla.components.concept.fetch/-response/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/fetch-httpurlconnection/src/main/java/mozilla/components/lib/fetch/httpurlconnection/HttpURLConnectionClient.kt#L24) + +Overrides [Client.fetch](../../mozilla.components.concept.fetch/-client/fetch.md) + +Starts the process of fetching a resource from the network as described by the [Request](../../mozilla.components.concept.fetch/-request/index.md) object. + +A [Response](../../mozilla.components.concept.fetch/-response/index.md) may keep references to open streams. Therefore it's important to always close the [Response](../../mozilla.components.concept.fetch/-response/index.md) or +its [Response.Body](../../mozilla.components.concept.fetch/-response/-body/index.md). + +Use the `use()` extension method when performing multiple operations on the [Response](../../mozilla.components.concept.fetch/-response/index.md) object: + +``` Kotlin +client.fetch(request).use { response -> + // Use response. Resources will get released automatically at the end of the block. +} +``` + +Alternatively you can use multiple `use*()` methods on the [Response.Body](../../mozilla.components.concept.fetch/-response/-body/index.md) object. + +### Parameters + +`request` - The request to be executed by this [Client](../../mozilla.components.concept.fetch/-client/index.md). + +### Exceptions + +`IOException` - if the request could not be executed due to cancellation, a connectivity problem or a +timeout. + +**Return** +The [Response](../../mozilla.components.concept.fetch/-response/index.md) returned by the server. + diff --git a/docs/api/mozilla.components.lib.fetch.httpurlconnection/-http-u-r-l-connection-client/index.md b/docs/api/mozilla.components.lib.fetch.httpurlconnection/-http-u-r-l-connection-client/index.md new file mode 100644 index 00000000000..5fc218ae9cd --- /dev/null +++ b/docs/api/mozilla.components.lib.fetch.httpurlconnection/-http-u-r-l-connection-client/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.lib.fetch.httpurlconnection](../index.md) / [HttpURLConnectionClient](./index.md) + +# HttpURLConnectionClient + +`class HttpURLConnectionClient : `[`Client`](../../mozilla.components.concept.fetch/-client/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/fetch-httpurlconnection/src/main/java/mozilla/components/lib/fetch/httpurlconnection/HttpURLConnectionClient.kt#L22) + +[HttpURLConnection](https://developer.android.com/reference/java/net/HttpURLConnection.html) implementation of [Client](../../mozilla.components.concept.fetch/-client/index.md). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `HttpURLConnectionClient()`
[HttpURLConnection](https://developer.android.com/reference/java/net/HttpURLConnection.html) implementation of [Client](../../mozilla.components.concept.fetch/-client/index.md). | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [defaultHeaders](../../mozilla.components.concept.fetch/-client/default-headers.md) | `val defaultHeaders: `[`Headers`](../../mozilla.components.concept.fetch/-headers/index.md)
List of default headers that should be added to every request unless overridden by the headers in the request. | + +### Functions + +| Name | Summary | +|---|---| +| [fetch](fetch.md) | `fun fetch(request: `[`Request`](../../mozilla.components.concept.fetch/-request/index.md)`): `[`Response`](../../mozilla.components.concept.fetch/-response/index.md)
Starts the process of fetching a resource from the network as described by the [Request](../../mozilla.components.concept.fetch/-request/index.md) object. | diff --git a/docs/api/mozilla.components.lib.fetch.httpurlconnection/index.md b/docs/api/mozilla.components.lib.fetch.httpurlconnection/index.md new file mode 100644 index 00000000000..f3f50b659b4 --- /dev/null +++ b/docs/api/mozilla.components.lib.fetch.httpurlconnection/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.lib.fetch.httpurlconnection](./index.md) + +## Package mozilla.components.lib.fetch.httpurlconnection + +### Types + +| Name | Summary | +|---|---| +| [HttpURLConnectionClient](-http-u-r-l-connection-client/index.md) | `class HttpURLConnectionClient : `[`Client`](../mozilla.components.concept.fetch/-client/index.md)
[HttpURLConnection](https://developer.android.com/reference/java/net/HttpURLConnection.html) implementation of [Client](../mozilla.components.concept.fetch/-client/index.md). | diff --git a/docs/api/mozilla.components.lib.fetch.okhttp/-ok-http-client/-init-.md b/docs/api/mozilla.components.lib.fetch.okhttp/-ok-http-client/-init-.md new file mode 100644 index 00000000000..ecb461bc085 --- /dev/null +++ b/docs/api/mozilla.components.lib.fetch.okhttp/-ok-http-client/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.fetch.okhttp](../index.md) / [OkHttpClient](index.md) / [<init>](./-init-.md) + +# <init> + +`OkHttpClient(client: OkHttpClient = OkHttpClient())` + +[Client](../../mozilla.components.concept.fetch/-client/index.md) implementation using OkHttp. + diff --git a/docs/api/mozilla.components.lib.fetch.okhttp/-ok-http-client/fetch.md b/docs/api/mozilla.components.lib.fetch.okhttp/-ok-http-client/fetch.md new file mode 100644 index 00000000000..df900e7cd91 --- /dev/null +++ b/docs/api/mozilla.components.lib.fetch.okhttp/-ok-http-client/fetch.md @@ -0,0 +1,35 @@ +[android-components](../../index.md) / [mozilla.components.lib.fetch.okhttp](../index.md) / [OkHttpClient](index.md) / [fetch](./fetch.md) + +# fetch + +`fun fetch(request: `[`Request`](../../mozilla.components.concept.fetch/-request/index.md)`): `[`Response`](../../mozilla.components.concept.fetch/-response/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/fetch-okhttp/src/main/java/mozilla/components/lib/fetch/okhttp/OkHttpClient.kt#L23) + +Overrides [Client.fetch](../../mozilla.components.concept.fetch/-client/fetch.md) + +Starts the process of fetching a resource from the network as described by the [Request](../../mozilla.components.concept.fetch/-request/index.md) object. + +A [Response](../../mozilla.components.concept.fetch/-response/index.md) may keep references to open streams. Therefore it's important to always close the [Response](../../mozilla.components.concept.fetch/-response/index.md) or +its [Response.Body](../../mozilla.components.concept.fetch/-response/-body/index.md). + +Use the `use()` extension method when performing multiple operations on the [Response](../../mozilla.components.concept.fetch/-response/index.md) object: + +``` Kotlin +client.fetch(request).use { response -> + // Use response. Resources will get released automatically at the end of the block. +} +``` + +Alternatively you can use multiple `use*()` methods on the [Response.Body](../../mozilla.components.concept.fetch/-response/-body/index.md) object. + +### Parameters + +`request` - The request to be executed by this [Client](../../mozilla.components.concept.fetch/-client/index.md). + +### Exceptions + +`IOException` - if the request could not be executed due to cancellation, a connectivity problem or a +timeout. + +**Return** +The [Response](../../mozilla.components.concept.fetch/-response/index.md) returned by the server. + diff --git a/docs/api/mozilla.components.lib.fetch.okhttp/-ok-http-client/index.md b/docs/api/mozilla.components.lib.fetch.okhttp/-ok-http-client/index.md new file mode 100644 index 00000000000..e1400efedbf --- /dev/null +++ b/docs/api/mozilla.components.lib.fetch.okhttp/-ok-http-client/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.lib.fetch.okhttp](../index.md) / [OkHttpClient](./index.md) + +# OkHttpClient + +`class OkHttpClient : `[`Client`](../../mozilla.components.concept.fetch/-client/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/fetch-okhttp/src/main/java/mozilla/components/lib/fetch/okhttp/OkHttpClient.kt#L20) + +[Client](../../mozilla.components.concept.fetch/-client/index.md) implementation using OkHttp. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `OkHttpClient(client: OkHttpClient = OkHttpClient())`
[Client](../../mozilla.components.concept.fetch/-client/index.md) implementation using OkHttp. | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [defaultHeaders](../../mozilla.components.concept.fetch/-client/default-headers.md) | `val defaultHeaders: `[`Headers`](../../mozilla.components.concept.fetch/-headers/index.md)
List of default headers that should be added to every request unless overridden by the headers in the request. | + +### Functions + +| Name | Summary | +|---|---| +| [fetch](fetch.md) | `fun fetch(request: `[`Request`](../../mozilla.components.concept.fetch/-request/index.md)`): `[`Response`](../../mozilla.components.concept.fetch/-response/index.md)
Starts the process of fetching a resource from the network as described by the [Request](../../mozilla.components.concept.fetch/-request/index.md) object. | diff --git a/docs/api/mozilla.components.lib.fetch.okhttp/-request-builder.md b/docs/api/mozilla.components.lib.fetch.okhttp/-request-builder.md new file mode 100644 index 00000000000..f4344bb9815 --- /dev/null +++ b/docs/api/mozilla.components.lib.fetch.okhttp/-request-builder.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.lib.fetch.okhttp](index.md) / [RequestBuilder](./-request-builder.md) + +# RequestBuilder + +`typealias RequestBuilder = Builder` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/fetch-okhttp/src/main/java/mozilla/components/lib/fetch/okhttp/OkHttpClient.kt#L15) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.fetch.okhttp/index.md b/docs/api/mozilla.components.lib.fetch.okhttp/index.md new file mode 100644 index 00000000000..f71806060ed --- /dev/null +++ b/docs/api/mozilla.components.lib.fetch.okhttp/index.md @@ -0,0 +1,15 @@ +[android-components](../index.md) / [mozilla.components.lib.fetch.okhttp](./index.md) + +## Package mozilla.components.lib.fetch.okhttp + +### Types + +| Name | Summary | +|---|---| +| [OkHttpClient](-ok-http-client/index.md) | `class OkHttpClient : `[`Client`](../mozilla.components.concept.fetch/-client/index.md)
[Client](../mozilla.components.concept.fetch/-client/index.md) implementation using OkHttp. | + +### Type Aliases + +| Name | Summary | +|---|---| +| [RequestBuilder](-request-builder.md) | `typealias RequestBuilder = Builder` | diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/-init-.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/-init-.md new file mode 100644 index 00000000000..87eba432d17 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/-init-.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](index.md) / [<init>](./-init-.md) + +# <init> + +`AstNode(type: `[`AstType`](../-ast-type/index.md)`, value: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`? = null, operator: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, left: `[`AstNode`](index.md)`? = null, right: `[`AstNode`](index.md)`? = null, from: `[`AstNode`](index.md)`? = null, relative: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, subject: `[`AstNode`](index.md)`? = null, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, expression: `[`AstNode`](index.md)`? = null, test: `[`AstNode`](index.md)`? = null, consequent: `[`AstNode`](index.md)`? = null, alternate: `[`AstNode`](index.md)`? = null, arguments: `[`MutableList`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`<`[`AstNode`](index.md)`> = mutableListOf())` + +A node of the abstract syntax tree. + +This class has a lot of properties because it needs to represent all types of nodes (See [AstType](../-ast-type/index.md)). It should be +possible to make this much simpler by creating a dedicated class for each type. + diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/alternate.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/alternate.md new file mode 100644 index 00000000000..6c669cc87a1 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/alternate.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](index.md) / [alternate](./alternate.md) + +# alternate + +`var alternate: `[`AstNode`](index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstNode.kt#L26) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/arguments.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/arguments.md new file mode 100644 index 00000000000..1d049f77d2a --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/arguments.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](index.md) / [arguments](./arguments.md) + +# arguments + +`val arguments: `[`MutableList`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`<`[`AstNode`](index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstNode.kt#L27) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/consequent.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/consequent.md new file mode 100644 index 00000000000..a0fdcdd2351 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/consequent.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](index.md) / [consequent](./consequent.md) + +# consequent + +`var consequent: `[`AstNode`](index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstNode.kt#L25) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/equals.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/equals.md new file mode 100644 index 00000000000..2d67583750f --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/equals.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](index.md) / [equals](./equals.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstNode.kt#L123) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/expression.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/expression.md new file mode 100644 index 00000000000..787d9bd8620 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/expression.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](index.md) / [expression](./expression.md) + +# expression + +`var expression: `[`AstNode`](index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstNode.kt#L23) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/from.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/from.md new file mode 100644 index 00000000000..d3bc5db71d4 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/from.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](index.md) / [from](./from.md) + +# from + +`var from: `[`AstNode`](index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstNode.kt#L19) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/index.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/index.md new file mode 100644 index 00000000000..eae8a851cb2 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/index.md @@ -0,0 +1,42 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](./index.md) + +# AstNode + +`data class AstNode` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstNode.kt#L13) + +A node of the abstract syntax tree. + +This class has a lot of properties because it needs to represent all types of nodes (See [AstType](../-ast-type/index.md)). It should be +possible to make this much simpler by creating a dedicated class for each type. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AstNode(type: `[`AstType`](../-ast-type/index.md)`, value: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`? = null, operator: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, left: `[`AstNode`](./index.md)`? = null, right: `[`AstNode`](./index.md)`? = null, from: `[`AstNode`](./index.md)`? = null, relative: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, subject: `[`AstNode`](./index.md)`? = null, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, expression: `[`AstNode`](./index.md)`? = null, test: `[`AstNode`](./index.md)`? = null, consequent: `[`AstNode`](./index.md)`? = null, alternate: `[`AstNode`](./index.md)`? = null, arguments: `[`MutableList`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`<`[`AstNode`](./index.md)`> = mutableListOf())`
A node of the abstract syntax tree. | + +### Properties + +| Name | Summary | +|---|---| +| [alternate](alternate.md) | `var alternate: `[`AstNode`](./index.md)`?` | +| [arguments](arguments.md) | `val arguments: `[`MutableList`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`<`[`AstNode`](./index.md)`>` | +| [consequent](consequent.md) | `var consequent: `[`AstNode`](./index.md)`?` | +| [expression](expression.md) | `var expression: `[`AstNode`](./index.md)`?` | +| [from](from.md) | `var from: `[`AstNode`](./index.md)`?` | +| [left](left.md) | `var left: `[`AstNode`](./index.md)`?` | +| [name](name.md) | `var name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [operator](operator.md) | `val operator: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [relative](relative.md) | `var relative: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [right](right.md) | `var right: `[`AstNode`](./index.md)`?` | +| [subject](subject.md) | `var subject: `[`AstNode`](./index.md)`?` | +| [test](test.md) | `var test: `[`AstNode`](./index.md)`?` | +| [type](type.md) | `val type: `[`AstType`](../-ast-type/index.md) | +| [value](value.md) | `var value: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?` | + +### Functions + +| Name | Summary | +|---|---| +| [equals](equals.md) | `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) | +| [toString](to-string.md) | `fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/left.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/left.md new file mode 100644 index 00000000000..56b85ea2e35 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/left.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](index.md) / [left](./left.md) + +# left + +`var left: `[`AstNode`](index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstNode.kt#L17) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/name.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/name.md new file mode 100644 index 00000000000..e1de62b8ba9 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/name.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](index.md) / [name](./name.md) + +# name + +`var name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstNode.kt#L22) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/operator.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/operator.md new file mode 100644 index 00000000000..7adab952abb --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/operator.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](index.md) / [operator](./operator.md) + +# operator + +`val operator: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstNode.kt#L16) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/relative.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/relative.md new file mode 100644 index 00000000000..b2c86b04a70 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/relative.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](index.md) / [relative](./relative.md) + +# relative + +`var relative: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstNode.kt#L20) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/right.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/right.md new file mode 100644 index 00000000000..aaa66a7cfde --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/right.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](index.md) / [right](./right.md) + +# right + +`var right: `[`AstNode`](index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstNode.kt#L18) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/subject.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/subject.md new file mode 100644 index 00000000000..89c864573ad --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/subject.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](index.md) / [subject](./subject.md) + +# subject + +`var subject: `[`AstNode`](index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstNode.kt#L21) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/test.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/test.md new file mode 100644 index 00000000000..99fb5610b5b --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/test.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](index.md) / [test](./test.md) + +# test + +`var test: `[`AstNode`](index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstNode.kt#L24) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/to-string.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/to-string.md new file mode 100644 index 00000000000..2f90b1d80f9 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/to-string.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](index.md) / [toString](./to-string.md) + +# toString + +`fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstNode.kt#L31) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/type.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/type.md new file mode 100644 index 00000000000..db4003766cf --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/type.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](index.md) / [type](./type.md) + +# type + +`val type: `[`AstType`](../-ast-type/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstNode.kt#L14) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-node/value.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/value.md new file mode 100644 index 00000000000..52c528b25d4 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-node/value.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstNode](index.md) / [value](./value.md) + +# value + +`var value: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstNode.kt#L15) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-a-r-r-a-y_-l-i-t-e-r-a-l.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-a-r-r-a-y_-l-i-t-e-r-a-l.md new file mode 100644 index 00000000000..3fc649502cf --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-a-r-r-a-y_-l-i-t-e-r-a-l.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstType](index.md) / [ARRAY_LITERAL](./-a-r-r-a-y_-l-i-t-e-r-a-l.md) + +# ARRAY_LITERAL + +`ARRAY_LITERAL` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstType.kt#L13) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-b-i-n-a-r-y_-e-x-p-r-e-s-s-i-o-n.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-b-i-n-a-r-y_-e-x-p-r-e-s-s-i-o-n.md new file mode 100644 index 00000000000..2aa246d7b5b --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-b-i-n-a-r-y_-e-x-p-r-e-s-s-i-o-n.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstType](index.md) / [BINARY_EXPRESSION](./-b-i-n-a-r-y_-e-x-p-r-e-s-s-i-o-n.md) + +# BINARY_EXPRESSION + +`BINARY_EXPRESSION` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstType.kt#L10) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-c-o-n-d-i-t-i-o-n-a-l_-e-x-p-r-e-s-s-i-o-n.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-c-o-n-d-i-t-i-o-n-a-l_-e-x-p-r-e-s-s-i-o-n.md new file mode 100644 index 00000000000..4e824b7a67a --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-c-o-n-d-i-t-i-o-n-a-l_-e-x-p-r-e-s-s-i-o-n.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstType](index.md) / [CONDITIONAL_EXPRESSION](./-c-o-n-d-i-t-i-o-n-a-l_-e-x-p-r-e-s-s-i-o-n.md) + +# CONDITIONAL_EXPRESSION + +`CONDITIONAL_EXPRESSION` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstType.kt#L16) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-f-i-l-t-e-r_-e-x-p-r-e-s-s-i-o-n.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-f-i-l-t-e-r_-e-x-p-r-e-s-s-i-o-n.md new file mode 100644 index 00000000000..5a7c321643b --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-f-i-l-t-e-r_-e-x-p-r-e-s-s-i-o-n.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstType](index.md) / [FILTER_EXPRESSION](./-f-i-l-t-e-r_-e-x-p-r-e-s-s-i-o-n.md) + +# FILTER_EXPRESSION + +`FILTER_EXPRESSION` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstType.kt#L15) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-i-d-e-n-t-i-f-i-e-r.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-i-d-e-n-t-i-f-i-e-r.md new file mode 100644 index 00000000000..0757ddf1f6c --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-i-d-e-n-t-i-f-i-e-r.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstType](index.md) / [IDENTIFIER](./-i-d-e-n-t-i-f-i-e-r.md) + +# IDENTIFIER + +`IDENTIFIER` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstType.kt#L11) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-l-i-t-e-r-a-l.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-l-i-t-e-r-a-l.md new file mode 100644 index 00000000000..519827cbf66 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-l-i-t-e-r-a-l.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstType](index.md) / [LITERAL](./-l-i-t-e-r-a-l.md) + +# LITERAL + +`LITERAL` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstType.kt#L8) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-o-b-j-e-c-t_-l-i-t-e-r-a-l.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-o-b-j-e-c-t_-l-i-t-e-r-a-l.md new file mode 100644 index 00000000000..4f8e7e3954d --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-o-b-j-e-c-t_-l-i-t-e-r-a-l.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstType](index.md) / [OBJECT_LITERAL](./-o-b-j-e-c-t_-l-i-t-e-r-a-l.md) + +# OBJECT_LITERAL + +`OBJECT_LITERAL` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstType.kt#L9) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-t-r-a-n-s-f-o-r-m.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-t-r-a-n-s-f-o-r-m.md new file mode 100644 index 00000000000..f496c5981de --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-t-r-a-n-s-f-o-r-m.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstType](index.md) / [TRANSFORM](./-t-r-a-n-s-f-o-r-m.md) + +# TRANSFORM + +`TRANSFORM` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstType.kt#L14) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-u-n-a-r-y_-e-x-p-r-e-s-s-i-o-n.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-u-n-a-r-y_-e-x-p-r-e-s-s-i-o-n.md new file mode 100644 index 00000000000..92a8d21e8e2 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/-u-n-a-r-y_-e-x-p-r-e-s-s-i-o-n.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstType](index.md) / [UNARY_EXPRESSION](./-u-n-a-r-y_-e-x-p-r-e-s-s-i-o-n.md) + +# UNARY_EXPRESSION + +`UNARY_EXPRESSION` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstType.kt#L12) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ast/-ast-type/index.md b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/index.md new file mode 100644 index 00000000000..555cc7ea766 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/-ast-type/index.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ast](../index.md) / [AstType](./index.md) + +# AstType + +`enum class AstType` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ast/AstType.kt#L7) + +### Enum Values + +| Name | Summary | +|---|---| +| [LITERAL](-l-i-t-e-r-a-l.md) | | +| [OBJECT_LITERAL](-o-b-j-e-c-t_-l-i-t-e-r-a-l.md) | | +| [BINARY_EXPRESSION](-b-i-n-a-r-y_-e-x-p-r-e-s-s-i-o-n.md) | | +| [IDENTIFIER](-i-d-e-n-t-i-f-i-e-r.md) | | +| [UNARY_EXPRESSION](-u-n-a-r-y_-e-x-p-r-e-s-s-i-o-n.md) | | +| [ARRAY_LITERAL](-a-r-r-a-y_-l-i-t-e-r-a-l.md) | | +| [TRANSFORM](-t-r-a-n-s-f-o-r-m.md) | | +| [FILTER_EXPRESSION](-f-i-l-t-e-r_-e-x-p-r-e-s-s-i-o-n.md) | | +| [CONDITIONAL_EXPRESSION](-c-o-n-d-i-t-i-o-n-a-l_-e-x-p-r-e-s-s-i-o-n.md) | | diff --git a/docs/api/mozilla.components.lib.jexl.ast/index.md b/docs/api/mozilla.components.lib.jexl.ast/index.md new file mode 100644 index 00000000000..e0b05bb7a0b --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ast/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.lib.jexl.ast](./index.md) + +## Package mozilla.components.lib.jexl.ast + +### Types + +| Name | Summary | +|---|---| +| [AstNode](-ast-node/index.md) | `data class AstNode`
A node of the abstract syntax tree. | +| [AstType](-ast-type/index.md) | `enum class AstType` | diff --git a/docs/api/mozilla.components.lib.jexl.evaluator/-jexl-context/-init-.md b/docs/api/mozilla.components.lib.jexl.evaluator/-jexl-context/-init-.md new file mode 100644 index 00000000000..edcaa6cf28e --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.evaluator/-jexl-context/-init-.md @@ -0,0 +1,29 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.evaluator](../index.md) / [JexlContext](index.md) / [<init>](./-init-.md) + +# <init> + +`JexlContext(vararg pairs: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md)`>)` + +Variables defined in the [JexlContext](index.md) are available to expressions. + +Example context: + +val context = JexlContext( + "employees" to JexlArray( + JexlObject( + "first" to "Sterling".toJexl(), + "last" to "Archer".toJexl(), + "age" to 36.toJexl()), + JexlObject( + "first" to "Malory".toJexl(), + "last" to "Archer".toJexl(), + "age" to 75.toJexl()), + JexlObject( + "first" to "Malory".toJexl(), + "last" to "Archer".toJexl(), + "age" to 33.toJexl()) + ) +) + +This context can be accessed in an JEXL expression like this: + diff --git a/docs/api/mozilla.components.lib.jexl.evaluator/-jexl-context/get.md b/docs/api/mozilla.components.lib.jexl.evaluator/-jexl-context/get.md new file mode 100644 index 00000000000..6e0f39e5948 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.evaluator/-jexl-context/get.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.evaluator](../index.md) / [JexlContext](index.md) / [get](./get.md) + +# get + +`fun get(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/evaluator/JexlContext.kt#L47) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.evaluator/-jexl-context/index.md b/docs/api/mozilla.components.lib.jexl.evaluator/-jexl-context/index.md new file mode 100644 index 00000000000..7f654614b59 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.evaluator/-jexl-context/index.md @@ -0,0 +1,41 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.evaluator](../index.md) / [JexlContext](./index.md) + +# JexlContext + +`class JexlContext` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/evaluator/JexlContext.kt#L38) + +Variables defined in the [JexlContext](./index.md) are available to expressions. + +Example context: + +val context = JexlContext( + "employees" to JexlArray( + JexlObject( + "first" to "Sterling".toJexl(), + "last" to "Archer".toJexl(), + "age" to 36.toJexl()), + JexlObject( + "first" to "Malory".toJexl(), + "last" to "Archer".toJexl(), + "age" to 75.toJexl()), + JexlObject( + "first" to "Malory".toJexl(), + "last" to "Archer".toJexl(), + "age" to 33.toJexl()) + ) +) + +This context can be accessed in an JEXL expression like this: + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `JexlContext(vararg pairs: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md)`>)`
Variables defined in the [JexlContext](./index.md) are available to expressions. | + +### Functions + +| Name | Summary | +|---|---| +| [get](get.md) | `fun get(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md) | +| [set](set.md) | `fun set(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, value: `[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.lib.jexl.evaluator/-jexl-context/set.md b/docs/api/mozilla.components.lib.jexl.evaluator/-jexl-context/set.md new file mode 100644 index 00000000000..12d58dd9f63 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.evaluator/-jexl-context/set.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.evaluator](../index.md) / [JexlContext](index.md) / [set](./set.md) + +# set + +`fun set(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, value: `[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/evaluator/JexlContext.kt#L43) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.evaluator/-transform.md b/docs/api/mozilla.components.lib.jexl.evaluator/-transform.md new file mode 100644 index 00000000000..818d66dc119 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.evaluator/-transform.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.lib.jexl.evaluator](index.md) / [Transform](./-transform.md) + +# Transform + +`typealias Transform = (`[`JexlValue`](../mozilla.components.lib.jexl.value/-jexl-value/index.md)`, `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`JexlValue`](../mozilla.components.lib.jexl.value/-jexl-value/index.md)`>) -> `[`JexlValue`](../mozilla.components.lib.jexl.value/-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/evaluator/Evaluator.kt#L18) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.evaluator/index.md b/docs/api/mozilla.components.lib.jexl.evaluator/index.md new file mode 100644 index 00000000000..a6e930c8219 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.evaluator/index.md @@ -0,0 +1,15 @@ +[android-components](../index.md) / [mozilla.components.lib.jexl.evaluator](./index.md) + +## Package mozilla.components.lib.jexl.evaluator + +### Types + +| Name | Summary | +|---|---| +| [JexlContext](-jexl-context/index.md) | `class JexlContext`
Variables defined in the [JexlContext](-jexl-context/index.md) are available to expressions. | + +### Type Aliases + +| Name | Summary | +|---|---| +| [Transform](-transform.md) | `typealias Transform = (`[`JexlValue`](../mozilla.components.lib.jexl.value/-jexl-value/index.md)`, `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`JexlValue`](../mozilla.components.lib.jexl.value/-jexl-value/index.md)`>) -> `[`JexlValue`](../mozilla.components.lib.jexl.value/-jexl-value/index.md) | diff --git a/docs/api/mozilla.components.lib.jexl.ext/index.md b/docs/api/mozilla.components.lib.jexl.ext/index.md new file mode 100644 index 00000000000..b6d1479f52c --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ext/index.md @@ -0,0 +1,14 @@ +[android-components](../index.md) / [mozilla.components.lib.jexl.ext](./index.md) + +## Package mozilla.components.lib.jexl.ext + +### Extensions for External Classes + +| Name | Summary | +|---|---| +| [kotlin.Boolean](kotlin.-boolean/index.md) | | +| [kotlin.Double](kotlin.-double/index.md) | | +| [kotlin.Float](kotlin.-float/index.md) | | +| [kotlin.Int](kotlin.-int/index.md) | | +| [kotlin.String](kotlin.-string/index.md) | | +| [kotlin.collections.List](kotlin.collections.-list/index.md) | | diff --git a/docs/api/mozilla.components.lib.jexl.ext/kotlin.-boolean/index.md b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-boolean/index.md new file mode 100644 index 00000000000..356120d5cd2 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-boolean/index.md @@ -0,0 +1,7 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ext](../index.md) / [kotlin.Boolean](./index.md) + +### Extensions for kotlin.Boolean + +| Name | Summary | +|---|---| +| [toJexl](to-jexl.md) | `fun `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`.toJexl(): `[`JexlBoolean`](../../mozilla.components.lib.jexl.value/-jexl-boolean/index.md) | diff --git a/docs/api/mozilla.components.lib.jexl.ext/kotlin.-boolean/to-jexl.md b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-boolean/to-jexl.md new file mode 100644 index 00000000000..bddb7baee51 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-boolean/to-jexl.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ext](../index.md) / [kotlin.Boolean](index.md) / [toJexl](./to-jexl.md) + +# toJexl + +`fun `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`.toJexl(): `[`JexlBoolean`](../../mozilla.components.lib.jexl.value/-jexl-boolean/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ext/JexlExtensions.kt#L32) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ext/kotlin.-double/index.md b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-double/index.md new file mode 100644 index 00000000000..8d2741815ba --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-double/index.md @@ -0,0 +1,7 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ext](../index.md) / [kotlin.Double](./index.md) + +### Extensions for kotlin.Double + +| Name | Summary | +|---|---| +| [toJexl](to-jexl.md) | `fun `[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`.toJexl(): `[`JexlDouble`](../../mozilla.components.lib.jexl.value/-jexl-double/index.md) | diff --git a/docs/api/mozilla.components.lib.jexl.ext/kotlin.-double/to-jexl.md b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-double/to-jexl.md new file mode 100644 index 00000000000..071e8a88b39 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-double/to-jexl.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ext](../index.md) / [kotlin.Double](index.md) / [toJexl](./to-jexl.md) + +# toJexl + +`fun `[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`.toJexl(): `[`JexlDouble`](../../mozilla.components.lib.jexl.value/-jexl-double/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ext/JexlExtensions.kt#L30) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ext/kotlin.-float/index.md b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-float/index.md new file mode 100644 index 00000000000..48c9459a79d --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-float/index.md @@ -0,0 +1,7 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ext](../index.md) / [kotlin.Float](./index.md) + +### Extensions for kotlin.Float + +| Name | Summary | +|---|---| +| [toJexl](to-jexl.md) | `fun `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`.toJexl(): `[`JexlDouble`](../../mozilla.components.lib.jexl.value/-jexl-double/index.md) | diff --git a/docs/api/mozilla.components.lib.jexl.ext/kotlin.-float/to-jexl.md b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-float/to-jexl.md new file mode 100644 index 00000000000..70be6121fcb --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-float/to-jexl.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ext](../index.md) / [kotlin.Float](index.md) / [toJexl](./to-jexl.md) + +# toJexl + +`fun `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`.toJexl(): `[`JexlDouble`](../../mozilla.components.lib.jexl.value/-jexl-double/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ext/JexlExtensions.kt#L31) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ext/kotlin.-int/index.md b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-int/index.md new file mode 100644 index 00000000000..40f84eddcdc --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-int/index.md @@ -0,0 +1,7 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ext](../index.md) / [kotlin.Int](./index.md) + +### Extensions for kotlin.Int + +| Name | Summary | +|---|---| +| [toJexl](to-jexl.md) | `fun `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`.toJexl(): `[`JexlInteger`](../../mozilla.components.lib.jexl.value/-jexl-integer/index.md) | diff --git a/docs/api/mozilla.components.lib.jexl.ext/kotlin.-int/to-jexl.md b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-int/to-jexl.md new file mode 100644 index 00000000000..c8d0110722b --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-int/to-jexl.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ext](../index.md) / [kotlin.Int](index.md) / [toJexl](./to-jexl.md) + +# toJexl + +`fun `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`.toJexl(): `[`JexlInteger`](../../mozilla.components.lib.jexl.value/-jexl-integer/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ext/JexlExtensions.kt#L29) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ext/kotlin.-string/index.md b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-string/index.md new file mode 100644 index 00000000000..bd8e05d2a03 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-string/index.md @@ -0,0 +1,7 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ext](../index.md) / [kotlin.String](./index.md) + +### Extensions for kotlin.String + +| Name | Summary | +|---|---| +| [toJexl](to-jexl.md) | `fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.toJexl(): `[`JexlString`](../../mozilla.components.lib.jexl.value/-jexl-string/index.md) | diff --git a/docs/api/mozilla.components.lib.jexl.ext/kotlin.-string/to-jexl.md b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-string/to-jexl.md new file mode 100644 index 00000000000..15ab438f1e4 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ext/kotlin.-string/to-jexl.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ext](../index.md) / [kotlin.String](index.md) / [toJexl](./to-jexl.md) + +# toJexl + +`fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.toJexl(): `[`JexlString`](../../mozilla.components.lib.jexl.value/-jexl-string/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ext/JexlExtensions.kt#L28) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.ext/kotlin.collections.-list/index.md b/docs/api/mozilla.components.lib.jexl.ext/kotlin.collections.-list/index.md new file mode 100644 index 00000000000..e31de07c0b6 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ext/kotlin.collections.-list/index.md @@ -0,0 +1,7 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ext](../index.md) / [kotlin.collections.List](./index.md) + +### Extensions for kotlin.collections.List + +| Name | Summary | +|---|---| +| [toJexlArray](to-jexl-array.md) | `fun `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`T`](to-jexl-array.md#T)`>.toJexlArray(): `[`JexlArray`](../../mozilla.components.lib.jexl.value/-jexl-array/index.md) | diff --git a/docs/api/mozilla.components.lib.jexl.ext/kotlin.collections.-list/to-jexl-array.md b/docs/api/mozilla.components.lib.jexl.ext/kotlin.collections.-list/to-jexl-array.md new file mode 100644 index 00000000000..c2d8b317a56 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.ext/kotlin.collections.-list/to-jexl-array.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.ext](../index.md) / [kotlin.collections.List](index.md) / [toJexlArray](./to-jexl-array.md) + +# toJexlArray + +`inline fun `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`T`](to-jexl-array.md#T)`>.toJexlArray(): `[`JexlArray`](../../mozilla.components.lib.jexl.value/-jexl-array/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/ext/JexlExtensions.kt#L15) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/-init-.md b/docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/-init-.md new file mode 100644 index 00000000000..42982c65953 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.grammar](../index.md) / [GrammarElement](index.md) / [<init>](./-init-.md) + +# <init> + +`GrammarElement(type: `[`Type`](../../mozilla.components.lib.jexl.lexer/-token/-type/index.md)`, precedence: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0, evaluate: (`[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md)`, `[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md)`) -> `[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md)` = null)` \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/evaluate.md b/docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/evaluate.md new file mode 100644 index 00000000000..c4916b55f8c --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/evaluate.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.grammar](../index.md) / [GrammarElement](index.md) / [evaluate](./evaluate.md) + +# evaluate + +`val evaluate: (`[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md)`, `[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md)`) -> `[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/grammar/Grammar.kt#L141) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/index.md b/docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/index.md new file mode 100644 index 00000000000..df8c70f4de9 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/index.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.grammar](../index.md) / [GrammarElement](./index.md) + +# GrammarElement + +`data class GrammarElement` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/grammar/Grammar.kt#L138) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `GrammarElement(type: `[`Type`](../../mozilla.components.lib.jexl.lexer/-token/-type/index.md)`, precedence: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0, evaluate: (`[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md)`, `[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md)`) -> `[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md)` = null)` | + +### Properties + +| Name | Summary | +|---|---| +| [evaluate](evaluate.md) | `val evaluate: (`[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md)`, `[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md)`) -> `[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md) | +| [precedence](precedence.md) | `val precedence: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [type](type.md) | `val type: `[`Type`](../../mozilla.components.lib.jexl.lexer/-token/-type/index.md) | diff --git a/docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/precedence.md b/docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/precedence.md new file mode 100644 index 00000000000..dc38ca1f337 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/precedence.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.grammar](../index.md) / [GrammarElement](index.md) / [precedence](./precedence.md) + +# precedence + +`val precedence: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/grammar/Grammar.kt#L140) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/type.md b/docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/type.md new file mode 100644 index 00000000000..bf4bf326d28 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.grammar/-grammar-element/type.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.grammar](../index.md) / [GrammarElement](index.md) / [type](./type.md) + +# type + +`val type: `[`Type`](../../mozilla.components.lib.jexl.lexer/-token/-type/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/grammar/Grammar.kt#L139) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.grammar/-grammar/-init-.md b/docs/api/mozilla.components.lib.jexl.grammar/-grammar/-init-.md new file mode 100644 index 00000000000..ec86dc81ba6 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.grammar/-grammar/-init-.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.grammar](../index.md) / [Grammar](index.md) / [<init>](./-init-.md) + +# <init> + +`Grammar()` + +Grammar of the JEXL language. + +Note that changes here may require a change in the Lexer or Parser. + diff --git a/docs/api/mozilla.components.lib.jexl.grammar/-grammar/elements.md b/docs/api/mozilla.components.lib.jexl.grammar/-grammar/elements.md new file mode 100644 index 00000000000..2840825e3a3 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.grammar/-grammar/elements.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.grammar](../index.md) / [Grammar](index.md) / [elements](./elements.md) + +# elements + +`val elements: `[`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)`, `[`GrammarElement`](../-grammar-element/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/grammar/Grammar.kt#L24) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.grammar/-grammar/index.md b/docs/api/mozilla.components.lib.jexl.grammar/-grammar/index.md new file mode 100644 index 00000000000..ec2e512ba45 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.grammar/-grammar/index.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.grammar](../index.md) / [Grammar](./index.md) + +# Grammar + +`class Grammar` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/grammar/Grammar.kt#L23) + +Grammar of the JEXL language. + +Note that changes here may require a change in the Lexer or Parser. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Grammar()`
Grammar of the JEXL language. | + +### Properties + +| Name | Summary | +|---|---| +| [elements](elements.md) | `val elements: `[`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)`, `[`GrammarElement`](../-grammar-element/index.md)`>` | diff --git a/docs/api/mozilla.components.lib.jexl.grammar/index.md b/docs/api/mozilla.components.lib.jexl.grammar/index.md new file mode 100644 index 00000000000..637ccc305a1 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.grammar/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.lib.jexl.grammar](./index.md) + +## Package mozilla.components.lib.jexl.grammar + +### Types + +| Name | Summary | +|---|---| +| [Grammar](-grammar/index.md) | `class Grammar`
Grammar of the JEXL language. | +| [GrammarElement](-grammar-element/index.md) | `data class GrammarElement` | diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/-init-.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/-init-.md new file mode 100644 index 00000000000..0a249d59afe --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.lexer](../index.md) / [Token](index.md) / [<init>](./-init-.md) + +# <init> + +`Token(type: `[`Type`](-type/index.md)`, raw: `[`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)`)` + +A token emitted by the [Lexer](#). + diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-b-i-n-a-r-y_-o-p.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-b-i-n-a-r-y_-o-p.md new file mode 100644 index 00000000000..726dc19b38f --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-b-i-n-a-r-y_-o-p.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.lib.jexl.lexer](../../index.md) / [Token](../index.md) / [Type](index.md) / [BINARY_OP](./-b-i-n-a-r-y_-o-p.md) + +# BINARY_OP + +`BINARY_OP` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L29) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-l-o-s-e_-b-r-a-c-k-e-t.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-l-o-s-e_-b-r-a-c-k-e-t.md new file mode 100644 index 00000000000..d63be68b7d1 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-l-o-s-e_-b-r-a-c-k-e-t.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.lib.jexl.lexer](../../index.md) / [Token](../index.md) / [Type](index.md) / [CLOSE_BRACKET](./-c-l-o-s-e_-b-r-a-c-k-e-t.md) + +# CLOSE_BRACKET + +`CLOSE_BRACKET` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L20) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-l-o-s-e_-c-u-r-l.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-l-o-s-e_-c-u-r-l.md new file mode 100644 index 00000000000..04b3ef7b6dd --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-l-o-s-e_-c-u-r-l.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.lib.jexl.lexer](../../index.md) / [Token](../index.md) / [Type](index.md) / [CLOSE_CURL](./-c-l-o-s-e_-c-u-r-l.md) + +# CLOSE_CURL + +`CLOSE_CURL` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L23) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-l-o-s-e_-p-a-r-e-n.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-l-o-s-e_-p-a-r-e-n.md new file mode 100644 index 00000000000..4692fabf372 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-l-o-s-e_-p-a-r-e-n.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.lib.jexl.lexer](../../index.md) / [Token](../index.md) / [Type](index.md) / [CLOSE_PAREN](./-c-l-o-s-e_-p-a-r-e-n.md) + +# CLOSE_PAREN + +`CLOSE_PAREN` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L27) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-o-l-o-n.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-o-l-o-n.md new file mode 100644 index 00000000000..e3f0e5e5355 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-o-l-o-n.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.lib.jexl.lexer](../../index.md) / [Token](../index.md) / [Type](index.md) / [COLON](./-c-o-l-o-n.md) + +# COLON + +`COLON` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L24) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-o-m-m-a.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-o-m-m-a.md new file mode 100644 index 00000000000..64303542868 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-c-o-m-m-a.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.lib.jexl.lexer](../../index.md) / [Token](../index.md) / [Type](index.md) / [COMMA](./-c-o-m-m-a.md) + +# COMMA + +`COMMA` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L25) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-d-o-t.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-d-o-t.md new file mode 100644 index 00000000000..cd4d6744b18 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-d-o-t.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.lib.jexl.lexer](../../index.md) / [Token](../index.md) / [Type](index.md) / [DOT](./-d-o-t.md) + +# DOT + +`DOT` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L18) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-i-d-e-n-t-i-f-i-e-r.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-i-d-e-n-t-i-f-i-e-r.md new file mode 100644 index 00000000000..440d90b1e08 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-i-d-e-n-t-i-f-i-e-r.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.lib.jexl.lexer](../../index.md) / [Token](../index.md) / [Type](index.md) / [IDENTIFIER](./-i-d-e-n-t-i-f-i-e-r.md) + +# IDENTIFIER + +`IDENTIFIER` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L17) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-l-i-t-e-r-a-l.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-l-i-t-e-r-a-l.md new file mode 100644 index 00000000000..3924cca6b2a --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-l-i-t-e-r-a-l.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.lib.jexl.lexer](../../index.md) / [Token](../index.md) / [Type](index.md) / [LITERAL](./-l-i-t-e-r-a-l.md) + +# LITERAL + +`LITERAL` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L16) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-o-p-e-n_-b-r-a-c-k-e-t.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-o-p-e-n_-b-r-a-c-k-e-t.md new file mode 100644 index 00000000000..487b2e825d0 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-o-p-e-n_-b-r-a-c-k-e-t.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.lib.jexl.lexer](../../index.md) / [Token](../index.md) / [Type](index.md) / [OPEN_BRACKET](./-o-p-e-n_-b-r-a-c-k-e-t.md) + +# OPEN_BRACKET + +`OPEN_BRACKET` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L19) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-o-p-e-n_-c-u-r-l.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-o-p-e-n_-c-u-r-l.md new file mode 100644 index 00000000000..8712d4f02d6 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-o-p-e-n_-c-u-r-l.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.lib.jexl.lexer](../../index.md) / [Token](../index.md) / [Type](index.md) / [OPEN_CURL](./-o-p-e-n_-c-u-r-l.md) + +# OPEN_CURL + +`OPEN_CURL` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L22) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-o-p-e-n_-p-a-r-e-n.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-o-p-e-n_-p-a-r-e-n.md new file mode 100644 index 00000000000..f887d56f59e --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-o-p-e-n_-p-a-r-e-n.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.lib.jexl.lexer](../../index.md) / [Token](../index.md) / [Type](index.md) / [OPEN_PAREN](./-o-p-e-n_-p-a-r-e-n.md) + +# OPEN_PAREN + +`OPEN_PAREN` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L26) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-p-i-p-e.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-p-i-p-e.md new file mode 100644 index 00000000000..6f04ff6a465 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-p-i-p-e.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.lib.jexl.lexer](../../index.md) / [Token](../index.md) / [Type](index.md) / [PIPE](./-p-i-p-e.md) + +# PIPE + +`PIPE` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L21) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-q-u-e-s-t-i-o-n.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-q-u-e-s-t-i-o-n.md new file mode 100644 index 00000000000..e2d9181c977 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-q-u-e-s-t-i-o-n.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.lib.jexl.lexer](../../index.md) / [Token](../index.md) / [Type](index.md) / [QUESTION](./-q-u-e-s-t-i-o-n.md) + +# QUESTION + +`QUESTION` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L28) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-u-n-a-r-y_-o-p.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-u-n-a-r-y_-o-p.md new file mode 100644 index 00000000000..f8c72822457 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/-u-n-a-r-y_-o-p.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.lib.jexl.lexer](../../index.md) / [Token](../index.md) / [Type](index.md) / [UNARY_OP](./-u-n-a-r-y_-o-p.md) + +# UNARY_OP + +`UNARY_OP` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L30) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/index.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/index.md new file mode 100644 index 00000000000..31250ad3807 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/-type/index.md @@ -0,0 +1,25 @@ +[android-components](../../../index.md) / [mozilla.components.lib.jexl.lexer](../../index.md) / [Token](../index.md) / [Type](./index.md) + +# Type + +`enum class Type` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L15) + +### Enum Values + +| Name | Summary | +|---|---| +| [LITERAL](-l-i-t-e-r-a-l.md) | | +| [IDENTIFIER](-i-d-e-n-t-i-f-i-e-r.md) | | +| [DOT](-d-o-t.md) | | +| [OPEN_BRACKET](-o-p-e-n_-b-r-a-c-k-e-t.md) | | +| [CLOSE_BRACKET](-c-l-o-s-e_-b-r-a-c-k-e-t.md) | | +| [PIPE](-p-i-p-e.md) | | +| [OPEN_CURL](-o-p-e-n_-c-u-r-l.md) | | +| [CLOSE_CURL](-c-l-o-s-e_-c-u-r-l.md) | | +| [COLON](-c-o-l-o-n.md) | | +| [COMMA](-c-o-m-m-a.md) | | +| [OPEN_PAREN](-o-p-e-n_-p-a-r-e-n.md) | | +| [CLOSE_PAREN](-c-l-o-s-e_-p-a-r-e-n.md) | | +| [QUESTION](-q-u-e-s-t-i-o-n.md) | | +| [BINARY_OP](-b-i-n-a-r-y_-o-p.md) | | +| [UNARY_OP](-u-n-a-r-y_-o-p.md) | | diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/index.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/index.md new file mode 100644 index 00000000000..76e263d37cf --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/index.md @@ -0,0 +1,27 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.lexer](../index.md) / [Token](./index.md) + +# Token + +`data class Token` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L10) + +A token emitted by the [Lexer](#). + +### Types + +| Name | Summary | +|---|---| +| [Type](-type/index.md) | `enum class Type` | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Token(type: `[`Type`](-type/index.md)`, raw: `[`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)`)`
A token emitted by the [Lexer](#). | + +### Properties + +| Name | Summary | +|---|---| +| [raw](raw.md) | `val raw: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [type](type.md) | `val type: `[`Type`](-type/index.md) | +| [value](value.md) | `val value: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/raw.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/raw.md new file mode 100644 index 00000000000..e9d936bb803 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/raw.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.lexer](../index.md) / [Token](index.md) / [raw](./raw.md) + +# raw + +`val raw: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L12) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/type.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/type.md new file mode 100644 index 00000000000..c07c389edc7 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/type.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.lexer](../index.md) / [Token](index.md) / [type](./type.md) + +# type + +`val type: `[`Type`](-type/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L11) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/-token/value.md b/docs/api/mozilla.components.lib.jexl.lexer/-token/value.md new file mode 100644 index 00000000000..215991b396d --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/-token/value.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.lexer](../index.md) / [Token](index.md) / [value](./value.md) + +# value + +`val value: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/lexer/Token.kt#L13) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.lexer/index.md b/docs/api/mozilla.components.lib.jexl.lexer/index.md new file mode 100644 index 00000000000..4851dfd0f75 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.lexer/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.lib.jexl.lexer](./index.md) + +## Package mozilla.components.lib.jexl.lexer + +### Types + +| Name | Summary | +|---|---| +| [Token](-token/index.md) | `data class Token`
A token emitted by the [Lexer](#). | diff --git a/docs/api/mozilla.components.lib.jexl.parser/-parser-exception/-init-.md b/docs/api/mozilla.components.lib.jexl.parser/-parser-exception/-init-.md new file mode 100644 index 00000000000..cf8fda1622e --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.parser/-parser-exception/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.parser](../index.md) / [ParserException](index.md) / [<init>](./-init-.md) + +# <init> + +`ParserException(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.parser/-parser-exception/index.md b/docs/api/mozilla.components.lib.jexl.parser/-parser-exception/index.md new file mode 100644 index 00000000000..a8bc46d7631 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.parser/-parser-exception/index.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.parser](../index.md) / [ParserException](./index.md) + +# ParserException + +`class ParserException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/parser/Parser.kt#L143) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ParserException(message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` | diff --git a/docs/api/mozilla.components.lib.jexl.parser/index.md b/docs/api/mozilla.components.lib.jexl.parser/index.md new file mode 100644 index 00000000000..9576d454106 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.parser/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.lib.jexl.parser](./index.md) + +## Package mozilla.components.lib.jexl.parser + +### Exceptions + +| Name | Summary | +|---|---| +| [ParserException](-parser-exception/index.md) | `class ParserException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) | diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-array/-init-.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/-init-.md new file mode 100644 index 00000000000..f90b0dc65e1 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlArray](index.md) / [<init>](./-init-.md) + +# <init> + +`JexlArray(vararg elements: `[`JexlValue`](../-jexl-value/index.md)`)``JexlArray(value: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`JexlValue`](../-jexl-value/index.md)`>)` + +JEXL Array type. + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-array/compare-to.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/compare-to.md new file mode 100644 index 00000000000..afaff1fefeb --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/compare-to.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlArray](index.md) / [compareTo](./compare-to.md) + +# compareTo + +`fun compareTo(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L232) + +Overrides [JexlValue.compareTo](../-jexl-value/compare-to.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-array/div.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/div.md new file mode 100644 index 00000000000..6268ae93ce9 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/div.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlArray](index.md) / [div](./div.md) + +# div + +`fun div(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L226) + +Overrides [JexlValue.div](../-jexl-value/div.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-array/equals.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/equals.md new file mode 100644 index 00000000000..a05f6f61c79 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/equals.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlArray](index.md) / [equals](./equals.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L234) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-array/hash-code.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/hash-code.md new file mode 100644 index 00000000000..3fc484bb354 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/hash-code.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlArray](index.md) / [hashCode](./hash-code.md) + +# hashCode + +`fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L240) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-array/index.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/index.md new file mode 100644 index 00000000000..e5d93453906 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/index.md @@ -0,0 +1,32 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlArray](./index.md) + +# JexlArray + +`class JexlArray : `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L221) + +JEXL Array type. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `JexlArray(vararg elements: `[`JexlValue`](../-jexl-value/index.md)`)``JexlArray(value: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`JexlValue`](../-jexl-value/index.md)`>)`
JEXL Array type. | + +### Properties + +| Name | Summary | +|---|---| +| [value](value.md) | `val value: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`JexlValue`](../-jexl-value/index.md)`>` | + +### Functions + +| Name | Summary | +|---|---| +| [compareTo](compare-to.md) | `fun compareTo(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [div](div.md) | `fun div(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [equals](equals.md) | `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.md) | `fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [plus](plus.md) | `fun plus(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [times](times.md) | `fun times(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [toBoolean](to-boolean.md) | `fun toBoolean(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [toString](to-string.md) | `fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-array/plus.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/plus.md new file mode 100644 index 00000000000..6d2f91e486e --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/plus.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlArray](index.md) / [plus](./plus.md) + +# plus + +`fun plus(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L230) + +Overrides [JexlValue.plus](../-jexl-value/plus.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-array/times.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/times.md new file mode 100644 index 00000000000..3f866ea3161 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/times.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlArray](index.md) / [times](./times.md) + +# times + +`fun times(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L228) + +Overrides [JexlValue.times](../-jexl-value/times.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-array/to-boolean.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/to-boolean.md new file mode 100644 index 00000000000..1b7d058c619 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/to-boolean.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlArray](index.md) / [toBoolean](./to-boolean.md) + +# toBoolean + +`fun toBoolean(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L236) + +Overrides [JexlValue.toBoolean](../-jexl-value/to-boolean.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-array/to-string.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/to-string.md new file mode 100644 index 00000000000..ee40f891958 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/to-string.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlArray](index.md) / [toString](./to-string.md) + +# toString + +`fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L238) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-array/value.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/value.md new file mode 100644 index 00000000000..0bb36222a5b --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-array/value.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlArray](index.md) / [value](./value.md) + +# value + +`val value: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`JexlValue`](../-jexl-value/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L222) + +Overrides [JexlValue.value](../-jexl-value/value.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/-init-.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/-init-.md new file mode 100644 index 00000000000..743dde0e973 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlBoolean](index.md) / [<init>](./-init-.md) + +# <init> + +`JexlBoolean(value: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` + +JEXL Boolean type. + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/compare-to.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/compare-to.md new file mode 100644 index 00000000000..93507117fa6 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/compare-to.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlBoolean](index.md) / [compareTo](./compare-to.md) + +# compareTo + +`fun compareTo(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L160) + +Overrides [JexlValue.compareTo](../-jexl-value/compare-to.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/div.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/div.md new file mode 100644 index 00000000000..1b89e83a565 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/div.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlBoolean](index.md) / [div](./div.md) + +# div + +`fun div(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L137) + +Overrides [JexlValue.div](../-jexl-value/div.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/equals.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/equals.md new file mode 100644 index 00000000000..82188716cd9 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/equals.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlBoolean](index.md) / [equals](./equals.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L166) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/hash-code.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/hash-code.md new file mode 100644 index 00000000000..5a2c871061e --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/hash-code.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlBoolean](index.md) / [hashCode](./hash-code.md) + +# hashCode + +`fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L172) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/index.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/index.md new file mode 100644 index 00000000000..49df1508b60 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/index.md @@ -0,0 +1,33 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlBoolean](./index.md) + +# JexlBoolean + +`class JexlBoolean : `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L136) + +JEXL Boolean type. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `JexlBoolean(value: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)`
JEXL Boolean type. | + +### Properties + +| Name | Summary | +|---|---| +| [value](value.md) | `val value: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [compareTo](compare-to.md) | `fun compareTo(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [div](div.md) | `fun div(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [equals](equals.md) | `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.md) | `fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [plus](plus.md) | `fun plus(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [times](times.md) | `fun times(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [toBoolean](to-boolean.md) | `fun toBoolean(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [toInt](to-int.md) | `fun toInt(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [toString](to-string.md) | `fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/plus.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/plus.md new file mode 100644 index 00000000000..ffd05be9c0a --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/plus.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlBoolean](index.md) / [plus](./plus.md) + +# plus + +`fun plus(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L150) + +Overrides [JexlValue.plus](../-jexl-value/plus.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/times.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/times.md new file mode 100644 index 00000000000..c374d181825 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/times.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlBoolean](index.md) / [times](./times.md) + +# times + +`fun times(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L141) + +Overrides [JexlValue.times](../-jexl-value/times.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/to-boolean.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/to-boolean.md new file mode 100644 index 00000000000..c152f124116 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/to-boolean.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlBoolean](index.md) / [toBoolean](./to-boolean.md) + +# toBoolean + +`fun toBoolean(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L168) + +Overrides [JexlValue.toBoolean](../-jexl-value/to-boolean.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/to-int.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/to-int.md new file mode 100644 index 00000000000..8c50762ffb7 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/to-int.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlBoolean](index.md) / [toInt](./to-int.md) + +# toInt + +`fun toInt(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L164) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/to-string.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/to-string.md new file mode 100644 index 00000000000..637a297d330 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/to-string.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlBoolean](index.md) / [toString](./to-string.md) + +# toString + +`fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L170) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/value.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/value.md new file mode 100644 index 00000000000..979060c1d26 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-boolean/value.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlBoolean](index.md) / [value](./value.md) + +# value + +`val value: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L136) + +Overrides [JexlValue.value](../-jexl-value/value.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-double/-init-.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/-init-.md new file mode 100644 index 00000000000..2409d157240 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlDouble](index.md) / [<init>](./-init-.md) + +# <init> + +`JexlDouble(value: `[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`)` + +JEXL Double type. + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-double/compare-to.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/compare-to.md new file mode 100644 index 00000000000..9e3eaa45836 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/compare-to.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlDouble](index.md) / [compareTo](./compare-to.md) + +# compareTo + +`fun compareTo(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L108) + +Overrides [JexlValue.compareTo](../-jexl-value/compare-to.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-double/div.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/div.md new file mode 100644 index 00000000000..ad7439664b4 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/div.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlDouble](index.md) / [div](./div.md) + +# div + +`fun div(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L81) + +Overrides [JexlValue.div](../-jexl-value/div.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-double/equals.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/equals.md new file mode 100644 index 00000000000..920dab1ccfc --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/equals.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlDouble](index.md) / [equals](./equals.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L118) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-double/hash-code.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/hash-code.md new file mode 100644 index 00000000000..ece5ca23e15 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/hash-code.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlDouble](index.md) / [hashCode](./hash-code.md) + +# hashCode + +`fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L130) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-double/index.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/index.md new file mode 100644 index 00000000000..ecab6d5d759 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/index.md @@ -0,0 +1,32 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlDouble](./index.md) + +# JexlDouble + +`class JexlDouble : `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L80) + +JEXL Double type. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `JexlDouble(value: `[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`)`
JEXL Double type. | + +### Properties + +| Name | Summary | +|---|---| +| [value](value.md) | `val value: `[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [compareTo](compare-to.md) | `fun compareTo(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [div](div.md) | `fun div(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [equals](equals.md) | `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.md) | `fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [plus](plus.md) | `fun plus(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [times](times.md) | `fun times(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [toBoolean](to-boolean.md) | `fun toBoolean(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [toString](to-string.md) | `fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-double/plus.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/plus.md new file mode 100644 index 00000000000..65aa51a5150 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/plus.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlDouble](index.md) / [plus](./plus.md) + +# plus + +`fun plus(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L98) + +Overrides [JexlValue.plus](../-jexl-value/plus.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-double/times.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/times.md new file mode 100644 index 00000000000..9ade3ca967f --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/times.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlDouble](index.md) / [times](./times.md) + +# times + +`fun times(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L89) + +Overrides [JexlValue.times](../-jexl-value/times.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-double/to-boolean.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/to-boolean.md new file mode 100644 index 00000000000..bb9521a4451 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/to-boolean.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlDouble](index.md) / [toBoolean](./to-boolean.md) + +# toBoolean + +`fun toBoolean(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L116) + +Overrides [JexlValue.toBoolean](../-jexl-value/to-boolean.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-double/to-string.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/to-string.md new file mode 100644 index 00000000000..9cd296273e5 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/to-string.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlDouble](index.md) / [toString](./to-string.md) + +# toString + +`fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L128) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-double/value.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/value.md new file mode 100644 index 00000000000..34f52699ef3 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-double/value.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlDouble](index.md) / [value](./value.md) + +# value + +`val value: `[`Double`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L80) + +Overrides [JexlValue.value](../-jexl-value/value.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/-init-.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/-init-.md new file mode 100644 index 00000000000..d290cc198a0 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlInteger](index.md) / [<init>](./-init-.md) + +# <init> + +`JexlInteger(value: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` + +JEXL Integer type. + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/compare-to.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/compare-to.md new file mode 100644 index 00000000000..abd9d259c24 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/compare-to.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlInteger](index.md) / [compareTo](./compare-to.md) + +# compareTo + +`fun compareTo(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L54) + +Overrides [JexlValue.compareTo](../-jexl-value/compare-to.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/div.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/div.md new file mode 100644 index 00000000000..3e19967e996 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/div.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlInteger](index.md) / [div](./div.md) + +# div + +`fun div(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L27) + +Overrides [JexlValue.div](../-jexl-value/div.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/equals.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/equals.md new file mode 100644 index 00000000000..2d4179792c4 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/equals.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlInteger](index.md) / [equals](./equals.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L62) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/hash-code.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/hash-code.md new file mode 100644 index 00000000000..da1d088ecc1 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/hash-code.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlInteger](index.md) / [hashCode](./hash-code.md) + +# hashCode + +`fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L74) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/index.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/index.md new file mode 100644 index 00000000000..ee4a06bea8d --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/index.md @@ -0,0 +1,32 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlInteger](./index.md) + +# JexlInteger + +`class JexlInteger : `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L26) + +JEXL Integer type. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `JexlInteger(value: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)`
JEXL Integer type. | + +### Properties + +| Name | Summary | +|---|---| +| [value](value.md) | `val value: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [compareTo](compare-to.md) | `fun compareTo(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [div](div.md) | `fun div(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [equals](equals.md) | `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.md) | `fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [plus](plus.md) | `fun plus(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [times](times.md) | `fun times(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [toBoolean](to-boolean.md) | `fun toBoolean(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [toString](to-string.md) | `fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/plus.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/plus.md new file mode 100644 index 00000000000..40519b8ca65 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/plus.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlInteger](index.md) / [plus](./plus.md) + +# plus + +`fun plus(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L44) + +Overrides [JexlValue.plus](../-jexl-value/plus.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/times.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/times.md new file mode 100644 index 00000000000..d8df4f96d89 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/times.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlInteger](index.md) / [times](./times.md) + +# times + +`fun times(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L35) + +Overrides [JexlValue.times](../-jexl-value/times.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/to-boolean.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/to-boolean.md new file mode 100644 index 00000000000..fe596c03337 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/to-boolean.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlInteger](index.md) / [toBoolean](./to-boolean.md) + +# toBoolean + +`fun toBoolean(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L70) + +Overrides [JexlValue.toBoolean](../-jexl-value/to-boolean.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/to-string.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/to-string.md new file mode 100644 index 00000000000..5408d88fb5d --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/to-string.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlInteger](index.md) / [toString](./to-string.md) + +# toString + +`fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L72) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/value.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/value.md new file mode 100644 index 00000000000..19acac2c854 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-integer/value.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlInteger](index.md) / [value](./value.md) + +# value + +`val value: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L26) + +Overrides [JexlValue.value](../-jexl-value/value.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-object/-init-.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/-init-.md new file mode 100644 index 00000000000..5cd35310df3 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlObject](index.md) / [<init>](./-init-.md) + +# <init> + +`JexlObject(vararg pairs: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`JexlValue`](../-jexl-value/index.md)`>)``JexlObject(value: `[`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)`, `[`JexlValue`](../-jexl-value/index.md)`>)` + +JEXL Object type. + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-object/compare-to.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/compare-to.md new file mode 100644 index 00000000000..833d826a8ee --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/compare-to.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlObject](index.md) / [compareTo](./compare-to.md) + +# compareTo + +`fun compareTo(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L263) + +Overrides [JexlValue.compareTo](../-jexl-value/compare-to.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-object/div.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/div.md new file mode 100644 index 00000000000..1b0cc3f5a5d --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/div.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlObject](index.md) / [div](./div.md) + +# div + +`fun div(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L251) + +Overrides [JexlValue.div](../-jexl-value/div.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-object/equals.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/equals.md new file mode 100644 index 00000000000..bce8401a8a2 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/equals.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlObject](index.md) / [equals](./equals.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L267) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-object/hash-code.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/hash-code.md new file mode 100644 index 00000000000..094966cd7dd --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/hash-code.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlObject](index.md) / [hashCode](./hash-code.md) + +# hashCode + +`fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L279) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-object/index.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/index.md new file mode 100644 index 00000000000..2dea1988d2a --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/index.md @@ -0,0 +1,32 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlObject](./index.md) + +# JexlObject + +`class JexlObject : `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L246) + +JEXL Object type. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `JexlObject(vararg pairs: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`JexlValue`](../-jexl-value/index.md)`>)``JexlObject(value: `[`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)`, `[`JexlValue`](../-jexl-value/index.md)`>)`
JEXL Object type. | + +### Properties + +| Name | Summary | +|---|---| +| [value](value.md) | `val value: `[`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)`, `[`JexlValue`](../-jexl-value/index.md)`>` | + +### Functions + +| Name | Summary | +|---|---| +| [compareTo](compare-to.md) | `fun compareTo(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [div](div.md) | `fun div(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [equals](equals.md) | `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.md) | `fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [plus](plus.md) | `fun plus(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [times](times.md) | `fun times(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [toBoolean](to-boolean.md) | `fun toBoolean(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [toString](to-string.md) | `fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-object/plus.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/plus.md new file mode 100644 index 00000000000..0481c1235f2 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/plus.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlObject](index.md) / [plus](./plus.md) + +# plus + +`fun plus(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L259) + +Overrides [JexlValue.plus](../-jexl-value/plus.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-object/times.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/times.md new file mode 100644 index 00000000000..7af89d47f24 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/times.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlObject](index.md) / [times](./times.md) + +# times + +`fun times(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L255) + +Overrides [JexlValue.times](../-jexl-value/times.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-object/to-boolean.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/to-boolean.md new file mode 100644 index 00000000000..f6eaa106ea2 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/to-boolean.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlObject](index.md) / [toBoolean](./to-boolean.md) + +# toBoolean + +`fun toBoolean(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L271) + +Overrides [JexlValue.toBoolean](../-jexl-value/to-boolean.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-object/to-string.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/to-string.md new file mode 100644 index 00000000000..89f514f1879 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/to-string.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlObject](index.md) / [toString](./to-string.md) + +# toString + +`fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L275) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-object/value.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/value.md new file mode 100644 index 00000000000..aa1cb68cf9e --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-object/value.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlObject](index.md) / [value](./value.md) + +# value + +`val value: `[`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)`, `[`JexlValue`](../-jexl-value/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L247) + +Overrides [JexlValue.value](../-jexl-value/value.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-string/-init-.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/-init-.md new file mode 100644 index 00000000000..97547947592 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlString](index.md) / [<init>](./-init-.md) + +# <init> + +`JexlString(value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +JEXL String type. + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-string/compare-to.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/compare-to.md new file mode 100644 index 00000000000..7e34e2b0c6f --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/compare-to.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlString](index.md) / [compareTo](./compare-to.md) + +# compareTo + +`fun compareTo(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L197) + +Overrides [JexlValue.compareTo](../-jexl-value/compare-to.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-string/div.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/div.md new file mode 100644 index 00000000000..158cc7e9a6e --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/div.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlString](index.md) / [div](./div.md) + +# div + +`fun div(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L179) + +Overrides [JexlValue.div](../-jexl-value/div.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-string/equals.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/equals.md new file mode 100644 index 00000000000..f527ed6c69b --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/equals.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlString](index.md) / [equals](./equals.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L201) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-string/hash-code.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/hash-code.md new file mode 100644 index 00000000000..40cebf9bb0f --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/hash-code.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlString](index.md) / [hashCode](./hash-code.md) + +# hashCode + +`fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L213) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-string/index.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/index.md new file mode 100644 index 00000000000..529e0ce7cdc --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/index.md @@ -0,0 +1,32 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlString](./index.md) + +# JexlString + +`class JexlString : `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L178) + +JEXL String type. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `JexlString(value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
JEXL String type. | + +### Properties + +| Name | Summary | +|---|---| +| [value](value.md) | `val value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [compareTo](compare-to.md) | `fun compareTo(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [div](div.md) | `fun div(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [equals](equals.md) | `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.md) | `fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [plus](plus.md) | `fun plus(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [times](times.md) | `fun times(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [toBoolean](to-boolean.md) | `fun toBoolean(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [toString](to-string.md) | `fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-string/plus.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/plus.md new file mode 100644 index 00000000000..f771810d7d2 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/plus.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlString](index.md) / [plus](./plus.md) + +# plus + +`fun plus(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L187) + +Overrides [JexlValue.plus](../-jexl-value/plus.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-string/times.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/times.md new file mode 100644 index 00000000000..a37988df431 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/times.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlString](index.md) / [times](./times.md) + +# times + +`fun times(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L183) + +Overrides [JexlValue.times](../-jexl-value/times.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-string/to-boolean.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/to-boolean.md new file mode 100644 index 00000000000..2e745b63bd3 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/to-boolean.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlString](index.md) / [toBoolean](./to-boolean.md) + +# toBoolean + +`fun toBoolean(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L205) + +Overrides [JexlValue.toBoolean](../-jexl-value/to-boolean.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-string/to-string.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/to-string.md new file mode 100644 index 00000000000..85f35d3107b --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/to-string.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlString](index.md) / [toString](./to-string.md) + +# toString + +`fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L209) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-string/value.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/value.md new file mode 100644 index 00000000000..a5f91e7d321 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-string/value.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlString](index.md) / [value](./value.md) + +# value + +`val value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L178) + +Overrides [JexlValue.value](../-jexl-value/value.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/-init-.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/-init-.md new file mode 100644 index 00000000000..ea1bc6b563c --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlUndefined](index.md) / [<init>](./-init-.md) + +# <init> + +`JexlUndefined()` + +JEXL undefined type. + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/compare-to.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/compare-to.md new file mode 100644 index 00000000000..f42f4acd335 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/compare-to.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlUndefined](index.md) / [compareTo](./compare-to.md) + +# compareTo + +`fun compareTo(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L298) + +Overrides [JexlValue.compareTo](../-jexl-value/compare-to.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/div.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/div.md new file mode 100644 index 00000000000..7ce21c33524 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/div.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlUndefined](index.md) / [div](./div.md) + +# div + +`fun div(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L296) + +Overrides [JexlValue.div](../-jexl-value/div.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/equals.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/equals.md new file mode 100644 index 00000000000..4392837f3d6 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/equals.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlUndefined](index.md) / [equals](./equals.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L304) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/hash-code.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/hash-code.md new file mode 100644 index 00000000000..beb35c6f2ed --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/hash-code.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlUndefined](index.md) / [hashCode](./hash-code.md) + +# hashCode + +`fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L306) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/index.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/index.md new file mode 100644 index 00000000000..a34c0684f00 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/index.md @@ -0,0 +1,32 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlUndefined](./index.md) + +# JexlUndefined + +`class JexlUndefined : `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L287) + +JEXL undefined type. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `JexlUndefined()`
JEXL undefined type. | + +### Properties + +| Name | Summary | +|---|---| +| [value](value.md) | `val value: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [compareTo](compare-to.md) | `fun compareTo(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [div](div.md) | `fun div(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [equals](equals.md) | `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.md) | `fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [plus](plus.md) | `fun plus(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [times](times.md) | `fun times(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) | +| [toBoolean](to-boolean.md) | `fun toBoolean(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [toString](to-string.md) | `fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/plus.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/plus.md new file mode 100644 index 00000000000..9e68bbd3b6a --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/plus.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlUndefined](index.md) / [plus](./plus.md) + +# plus + +`fun plus(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L290) + +Overrides [JexlValue.plus](../-jexl-value/plus.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/times.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/times.md new file mode 100644 index 00000000000..dc39f07832d --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/times.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlUndefined](index.md) / [times](./times.md) + +# times + +`fun times(other: `[`JexlValue`](../-jexl-value/index.md)`): `[`JexlValue`](../-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L294) + +Overrides [JexlValue.times](../-jexl-value/times.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/to-boolean.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/to-boolean.md new file mode 100644 index 00000000000..332a0ab3f65 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/to-boolean.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlUndefined](index.md) / [toBoolean](./to-boolean.md) + +# toBoolean + +`fun toBoolean(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L300) + +Overrides [JexlValue.toBoolean](../-jexl-value/to-boolean.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/to-string.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/to-string.md new file mode 100644 index 00000000000..94be87f086d --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/to-string.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlUndefined](index.md) / [toString](./to-string.md) + +# toString + +`fun toString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L302) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/value.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/value.md new file mode 100644 index 00000000000..5e8bc27f598 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-undefined/value.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlUndefined](index.md) / [value](./value.md) + +# value + +`val value: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L288) + +Overrides [JexlValue.value](../-jexl-value/value.md) + diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-value/compare-to.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-value/compare-to.md new file mode 100644 index 00000000000..512f1e2ab79 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-value/compare-to.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlValue](index.md) / [compareTo](./compare-to.md) + +# compareTo + +`abstract operator fun compareTo(other: `[`JexlValue`](index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L18) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-value/div.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-value/div.md new file mode 100644 index 00000000000..4e6932664dc --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-value/div.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlValue](index.md) / [div](./div.md) + +# div + +`abstract operator fun div(other: `[`JexlValue`](index.md)`): `[`JexlValue`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L17) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-value/index.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-value/index.md new file mode 100644 index 00000000000..32f5a0765b7 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-value/index.md @@ -0,0 +1,35 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlValue](./index.md) + +# JexlValue + +`sealed class JexlValue` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L12) + +A JEXL value type. + +### Properties + +| Name | Summary | +|---|---| +| [value](value.md) | `abstract val value: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [compareTo](compare-to.md) | `abstract operator fun compareTo(other: `[`JexlValue`](./index.md)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [div](div.md) | `abstract operator fun div(other: `[`JexlValue`](./index.md)`): `[`JexlValue`](./index.md) | +| [plus](plus.md) | `abstract operator fun plus(other: `[`JexlValue`](./index.md)`): `[`JexlValue`](./index.md) | +| [times](times.md) | `abstract operator fun times(other: `[`JexlValue`](./index.md)`): `[`JexlValue`](./index.md) | +| [toBoolean](to-boolean.md) | `abstract fun toBoolean(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [JexlArray](../-jexl-array/index.md) | `class JexlArray : `[`JexlValue`](./index.md)
JEXL Array type. | +| [JexlBoolean](../-jexl-boolean/index.md) | `class JexlBoolean : `[`JexlValue`](./index.md)
JEXL Boolean type. | +| [JexlDouble](../-jexl-double/index.md) | `class JexlDouble : `[`JexlValue`](./index.md)
JEXL Double type. | +| [JexlInteger](../-jexl-integer/index.md) | `class JexlInteger : `[`JexlValue`](./index.md)
JEXL Integer type. | +| [JexlObject](../-jexl-object/index.md) | `class JexlObject : `[`JexlValue`](./index.md)
JEXL Object type. | +| [JexlString](../-jexl-string/index.md) | `class JexlString : `[`JexlValue`](./index.md)
JEXL String type. | +| [JexlUndefined](../-jexl-undefined/index.md) | `class JexlUndefined : `[`JexlValue`](./index.md)
JEXL undefined type. | diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-value/plus.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-value/plus.md new file mode 100644 index 00000000000..d27c3650c08 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-value/plus.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlValue](index.md) / [plus](./plus.md) + +# plus + +`abstract operator fun plus(other: `[`JexlValue`](index.md)`): `[`JexlValue`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L15) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-value/times.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-value/times.md new file mode 100644 index 00000000000..c9a171903da --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-value/times.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlValue](index.md) / [times](./times.md) + +# times + +`abstract operator fun times(other: `[`JexlValue`](index.md)`): `[`JexlValue`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L16) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-value/to-boolean.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-value/to-boolean.md new file mode 100644 index 00000000000..e399daa08b6 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-value/to-boolean.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlValue](index.md) / [toBoolean](./to-boolean.md) + +# toBoolean + +`abstract fun toBoolean(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L20) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/-jexl-value/value.md b/docs/api/mozilla.components.lib.jexl.value/-jexl-value/value.md new file mode 100644 index 00000000000..ffb85b7886d --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/-jexl-value/value.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl.value](../index.md) / [JexlValue](index.md) / [value](./value.md) + +# value + +`abstract val value: `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/value/JexlValue.kt#L13) \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl.value/index.md b/docs/api/mozilla.components.lib.jexl.value/index.md new file mode 100644 index 00000000000..0749a0d0267 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl.value/index.md @@ -0,0 +1,16 @@ +[android-components](../index.md) / [mozilla.components.lib.jexl.value](./index.md) + +## Package mozilla.components.lib.jexl.value + +### Types + +| Name | Summary | +|---|---| +| [JexlArray](-jexl-array/index.md) | `class JexlArray : `[`JexlValue`](-jexl-value/index.md)
JEXL Array type. | +| [JexlBoolean](-jexl-boolean/index.md) | `class JexlBoolean : `[`JexlValue`](-jexl-value/index.md)
JEXL Boolean type. | +| [JexlDouble](-jexl-double/index.md) | `class JexlDouble : `[`JexlValue`](-jexl-value/index.md)
JEXL Double type. | +| [JexlInteger](-jexl-integer/index.md) | `class JexlInteger : `[`JexlValue`](-jexl-value/index.md)
JEXL Integer type. | +| [JexlObject](-jexl-object/index.md) | `class JexlObject : `[`JexlValue`](-jexl-value/index.md)
JEXL Object type. | +| [JexlString](-jexl-string/index.md) | `class JexlString : `[`JexlValue`](-jexl-value/index.md)
JEXL String type. | +| [JexlUndefined](-jexl-undefined/index.md) | `class JexlUndefined : `[`JexlValue`](-jexl-value/index.md)
JEXL undefined type. | +| [JexlValue](-jexl-value/index.md) | `sealed class JexlValue`
A JEXL value type. | diff --git a/docs/api/mozilla.components.lib.jexl/-jexl-exception/-init-.md b/docs/api/mozilla.components.lib.jexl/-jexl-exception/-init-.md new file mode 100644 index 00000000000..97cf61a8489 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl/-jexl-exception/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl](../index.md) / [JexlException](index.md) / [<init>](./-init-.md) + +# <init> + +`JexlException(cause: `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)`? = null, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)` + +Generic exception thrown when evaluating an expression failed. + diff --git a/docs/api/mozilla.components.lib.jexl/-jexl-exception/index.md b/docs/api/mozilla.components.lib.jexl/-jexl-exception/index.md new file mode 100644 index 00000000000..2731367cc5f --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl/-jexl-exception/index.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl](../index.md) / [JexlException](./index.md) + +# JexlException + +`class JexlException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/Jexl.kt#L99) + +Generic exception thrown when evaluating an expression failed. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `JexlException(cause: `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)`? = null, message: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)`
Generic exception thrown when evaluating an expression failed. | diff --git a/docs/api/mozilla.components.lib.jexl/-jexl/-init-.md b/docs/api/mozilla.components.lib.jexl/-jexl/-init-.md new file mode 100644 index 00000000000..7f43d978118 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl/-jexl/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl](../index.md) / [Jexl](index.md) / [<init>](./-init-.md) + +# <init> + +`Jexl(grammar: `[`Grammar`](../../mozilla.components.lib.jexl.grammar/-grammar/index.md)` = Grammar())` \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl/-jexl/add-transform.md b/docs/api/mozilla.components.lib.jexl/-jexl/add-transform.md new file mode 100644 index 00000000000..7a781d223a2 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl/-jexl/add-transform.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl](../index.md) / [Jexl](index.md) / [addTransform](./add-transform.md) + +# addTransform + +`fun addTransform(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, transform: `[`Transform`](../../mozilla.components.lib.jexl.evaluator/-transform.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/Jexl.kt#L34) + +Adds or replaces a transform function in this Jexl instance. + +### Parameters + +`name` - The name of the transform function, as it will be used within Jexl expressions. + +`transform` - The function to be executed when this transform is invoked. It will be + provided with two arguments: + - value: The value to be transformed + - arguments: The list of arguments for this transform. \ No newline at end of file diff --git a/docs/api/mozilla.components.lib.jexl/-jexl/evaluate-boolean-expression.md b/docs/api/mozilla.components.lib.jexl/-jexl/evaluate-boolean-expression.md new file mode 100644 index 00000000000..e332c121c6e --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl/-jexl/evaluate-boolean-expression.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl](../index.md) / [Jexl](index.md) / [evaluateBooleanExpression](./evaluate-boolean-expression.md) + +# evaluateBooleanExpression + +`fun evaluateBooleanExpression(expression: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, context: `[`JexlContext`](../../mozilla.components.lib.jexl.evaluator/-jexl-context/index.md)` = JexlContext(), defaultValue: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`? = null): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/Jexl.kt#L73) + +Evaluates a Jexl string with an optional context to a Boolean result. Optionally a default +value can be provided that will be returned in the expression does not return a boolean +result. + diff --git a/docs/api/mozilla.components.lib.jexl/-jexl/evaluate.md b/docs/api/mozilla.components.lib.jexl/-jexl/evaluate.md new file mode 100644 index 00000000000..6f069e0b37e --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl/-jexl/evaluate.md @@ -0,0 +1,22 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl](../index.md) / [Jexl](index.md) / [evaluate](./evaluate.md) + +# evaluate + +`fun evaluate(expression: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, context: `[`JexlContext`](../../mozilla.components.lib.jexl.evaluator/-jexl-context/index.md)` = JexlContext()): `[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/Jexl.kt#L49) + +Evaluates a Jexl string within an optional context. + +### Parameters + +`expression` - The Jexl expression to be evaluated. + +`context` - A mapping of variables to values, which will be made accessible to the Jexl + expression when evaluating it. + +### Exceptions + +`JexlException` - if lexing, parsing or evaluating the expression failed. + +**Return** +The result of the evaluation. + diff --git a/docs/api/mozilla.components.lib.jexl/-jexl/index.md b/docs/api/mozilla.components.lib.jexl/-jexl/index.md new file mode 100644 index 00000000000..a1366db583f --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl/-jexl/index.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.lib.jexl](../index.md) / [Jexl](./index.md) + +# Jexl + +`class Jexl` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/jexl/src/main/java/mozilla/components/lib/jexl/Jexl.kt#L19) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Jexl(grammar: `[`Grammar`](../../mozilla.components.lib.jexl.grammar/-grammar/index.md)` = Grammar())` | + +### Functions + +| Name | Summary | +|---|---| +| [addTransform](add-transform.md) | `fun addTransform(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, transform: `[`Transform`](../../mozilla.components.lib.jexl.evaluator/-transform.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Adds or replaces a transform function in this Jexl instance. | +| [evaluate](evaluate.md) | `fun evaluate(expression: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, context: `[`JexlContext`](../../mozilla.components.lib.jexl.evaluator/-jexl-context/index.md)` = JexlContext()): `[`JexlValue`](../../mozilla.components.lib.jexl.value/-jexl-value/index.md)
Evaluates a Jexl string within an optional context. | +| [evaluateBooleanExpression](evaluate-boolean-expression.md) | `fun evaluateBooleanExpression(expression: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, context: `[`JexlContext`](../../mozilla.components.lib.jexl.evaluator/-jexl-context/index.md)` = JexlContext(), defaultValue: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`? = null): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Evaluates a Jexl string with an optional context to a Boolean result. Optionally a default value can be provided that will be returned in the expression does not return a boolean result. | diff --git a/docs/api/mozilla.components.lib.jexl/index.md b/docs/api/mozilla.components.lib.jexl/index.md new file mode 100644 index 00000000000..3591c7398c7 --- /dev/null +++ b/docs/api/mozilla.components.lib.jexl/index.md @@ -0,0 +1,15 @@ +[android-components](../index.md) / [mozilla.components.lib.jexl](./index.md) + +## Package mozilla.components.lib.jexl + +### Types + +| Name | Summary | +|---|---| +| [Jexl](-jexl/index.md) | `class Jexl` | + +### Exceptions + +| Name | Summary | +|---|---| +| [JexlException](-jexl-exception/index.md) | `class JexlException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)
Generic exception thrown when evaluating an expression failed. | diff --git a/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/-init-.md b/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/-init-.md new file mode 100644 index 00000000000..c10d3c4e874 --- /dev/null +++ b/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/-init-.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.lib.publicsuffixlist](../index.md) / [PublicSuffixList](index.md) / [<init>](./-init-.md) + +# <init> + +`PublicSuffixList(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, dispatcher: CoroutineDispatcher = Dispatchers.IO, scope: CoroutineScope = CoroutineScope(dispatcher))` + +API for reading and accessing the public suffix list. + +A "public suffix" is one under which Internet users can (or historically could) directly register names. Some + examples of public suffixes are .com, .co.uk and pvt.k12.ma.us. The Public Suffix List is a list of all known + public suffixes. + +Note that this implementation applies the rules of the public suffix list only and does not validate domains. + +https://publicsuffix.org/ +https://github.com/publicsuffix/list + diff --git a/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/get-public-suffix-plus-one.md b/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/get-public-suffix-plus-one.md new file mode 100644 index 00000000000..b6ba239b5f0 --- /dev/null +++ b/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/get-public-suffix-plus-one.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.lib.publicsuffixlist](../index.md) / [PublicSuffixList](index.md) / [getPublicSuffixPlusOne](./get-public-suffix-plus-one.md) + +# getPublicSuffixPlusOne + +`fun getPublicSuffixPlusOne(domain: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/publicsuffixlist/src/main/java/mozilla/components/lib/publicsuffixlist/PublicSuffixList.kt#L72) + +Returns the public suffix and one more level; known as the effective top-level domain (eTLD). Returns `null` if +[domain](get-public-suffix-plus-one.md#mozilla.components.lib.publicsuffixlist.PublicSuffixList$getPublicSuffixPlusOne(kotlin.String)/domain) is a public suffix itself. + +E.g.: + +``` +wwww.mozilla.org -> mozilla.org +www.bcc.co.uk -> bbc.co.uk +a.b.ide.kyoto.jp -> b.ide.kyoto.jp +``` + diff --git a/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/get-public-suffix.md b/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/get-public-suffix.md new file mode 100644 index 00000000000..b4cec89e507 --- /dev/null +++ b/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/get-public-suffix.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.lib.publicsuffixlist](../index.md) / [PublicSuffixList](index.md) / [getPublicSuffix](./get-public-suffix.md) + +# getPublicSuffix + +`fun getPublicSuffix(domain: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): ` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/publicsuffixlist/src/main/java/mozilla/components/lib/publicsuffixlist/PublicSuffixList.kt#L92) + +Returns the public suffix of the given [domain](get-public-suffix.md#mozilla.components.lib.publicsuffixlist.PublicSuffixList$getPublicSuffix(kotlin.String)/domain). Returns `null` if the [domain](get-public-suffix.md#mozilla.components.lib.publicsuffixlist.PublicSuffixList$getPublicSuffix(kotlin.String)/domain) is a public suffix itself. + +E.g.: + +``` +wwww.mozilla.org -> org +www.bcc.co.uk -> co.uk +a.b.ide.kyoto.jp -> ide.kyoto.jp +``` + diff --git a/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/index.md b/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/index.md new file mode 100644 index 00000000000..4c41bca6134 --- /dev/null +++ b/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/index.md @@ -0,0 +1,32 @@ +[android-components](../../index.md) / [mozilla.components.lib.publicsuffixlist](../index.md) / [PublicSuffixList](./index.md) + +# PublicSuffixList + +`class PublicSuffixList` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/publicsuffixlist/src/main/java/mozilla/components/lib/publicsuffixlist/PublicSuffixList.kt#L26) + +API for reading and accessing the public suffix list. + +A "public suffix" is one under which Internet users can (or historically could) directly register names. Some + examples of public suffixes are .com, .co.uk and pvt.k12.ma.us. The Public Suffix List is a list of all known + public suffixes. + +Note that this implementation applies the rules of the public suffix list only and does not validate domains. + +https://publicsuffix.org/ +https://github.com/publicsuffix/list + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `PublicSuffixList(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, dispatcher: CoroutineDispatcher = Dispatchers.IO, scope: CoroutineScope = CoroutineScope(dispatcher))`
API for reading and accessing the public suffix list. | + +### Functions + +| Name | Summary | +|---|---| +| [getPublicSuffix](get-public-suffix.md) | `fun getPublicSuffix(domain: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `
Returns the public suffix of the given [domain](get-public-suffix.md#mozilla.components.lib.publicsuffixlist.PublicSuffixList$getPublicSuffix(kotlin.String)/domain). Returns `null` if the [domain](get-public-suffix.md#mozilla.components.lib.publicsuffixlist.PublicSuffixList$getPublicSuffix(kotlin.String)/domain) is a public suffix itself. | +| [getPublicSuffixPlusOne](get-public-suffix-plus-one.md) | `fun getPublicSuffixPlusOne(domain: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?>`
Returns the public suffix and one more level; known as the effective top-level domain (eTLD). Returns `null` if [domain](get-public-suffix-plus-one.md#mozilla.components.lib.publicsuffixlist.PublicSuffixList$getPublicSuffixPlusOne(kotlin.String)/domain) is a public suffix itself. | +| [isPublicSuffix](is-public-suffix.md) | `fun isPublicSuffix(domain: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>`
Returns true if the given [domain](is-public-suffix.md#mozilla.components.lib.publicsuffixlist.PublicSuffixList$isPublicSuffix(kotlin.String)/domain) is a public suffix; false otherwise. | +| [prefetch](prefetch.md) | `fun prefetch(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Prefetch the public suffix list from disk so that it is available in memory. | +| [stripPublicSuffix](strip-public-suffix.md) | `fun stripPublicSuffix(domain: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `
Strips the public suffix from the given [domain](strip-public-suffix.md#mozilla.components.lib.publicsuffixlist.PublicSuffixList$stripPublicSuffix(kotlin.String)/domain). Returns the original domain if no public suffix could be stripped. | diff --git a/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/is-public-suffix.md b/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/is-public-suffix.md new file mode 100644 index 00000000000..fa8ae8714c9 --- /dev/null +++ b/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/is-public-suffix.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.lib.publicsuffixlist](../index.md) / [PublicSuffixList](index.md) / [isPublicSuffix](./is-public-suffix.md) + +# isPublicSuffix + +`fun isPublicSuffix(domain: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/publicsuffixlist/src/main/java/mozilla/components/lib/publicsuffixlist/PublicSuffixList.kt#L54) + +Returns true if the given [domain](is-public-suffix.md#mozilla.components.lib.publicsuffixlist.PublicSuffixList$isPublicSuffix(kotlin.String)/domain) is a public suffix; false otherwise. + +E.g.: + +``` +co.uk -> true +com -> true +mozilla.org -> false +org -> true +``` + +Note that this method ignores the default "prevailing rule" described in the formal public suffix list algorithm: +If no rule matches then the passed [domain](is-public-suffix.md#mozilla.components.lib.publicsuffixlist.PublicSuffixList$isPublicSuffix(kotlin.String)/domain) is assumed to *not* be a public suffix. + diff --git a/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/prefetch.md b/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/prefetch.md new file mode 100644 index 00000000000..ba403335c00 --- /dev/null +++ b/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/prefetch.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.lib.publicsuffixlist](../index.md) / [PublicSuffixList](index.md) / [prefetch](./prefetch.md) + +# prefetch + +`fun prefetch(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/publicsuffixlist/src/main/java/mozilla/components/lib/publicsuffixlist/PublicSuffixList.kt#L36) + +Prefetch the public suffix list from disk so that it is available in memory. + diff --git a/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/strip-public-suffix.md b/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/strip-public-suffix.md new file mode 100644 index 00000000000..88a4fc8110c --- /dev/null +++ b/docs/api/mozilla.components.lib.publicsuffixlist/-public-suffix-list/strip-public-suffix.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.lib.publicsuffixlist](../index.md) / [PublicSuffixList](index.md) / [stripPublicSuffix](./strip-public-suffix.md) + +# stripPublicSuffix + +`fun stripPublicSuffix(domain: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): ` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/lib/publicsuffixlist/src/main/java/mozilla/components/lib/publicsuffixlist/PublicSuffixList.kt#L113) + +Strips the public suffix from the given [domain](strip-public-suffix.md#mozilla.components.lib.publicsuffixlist.PublicSuffixList$stripPublicSuffix(kotlin.String)/domain). Returns the original domain if no public suffix could be +stripped. + +E.g.: + +``` +wwww.mozilla.org -> www.mozilla +www.bcc.co.uk -> www.bbc +a.b.ide.kyoto.jp -> a.b +``` + diff --git a/docs/api/mozilla.components.lib.publicsuffixlist/index.md b/docs/api/mozilla.components.lib.publicsuffixlist/index.md new file mode 100644 index 00000000000..7738a0bc241 --- /dev/null +++ b/docs/api/mozilla.components.lib.publicsuffixlist/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.lib.publicsuffixlist](./index.md) + +## Package mozilla.components.lib.publicsuffixlist + +### Types + +| Name | Summary | +|---|---| +| [PublicSuffixList](-public-suffix-list/index.md) | `class PublicSuffixList`
API for reading and accessing the public suffix list. | diff --git a/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/-init-.md b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/-init-.md new file mode 100644 index 00000000000..d8692d71b20 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/-init-.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.scheduler.jobscheduler](../index.md) / [JobSchedulerSyncScheduler](index.md) / [<init>](./-init-.md) + +# <init> + +`JobSchedulerSyncScheduler(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`)` + +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/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/index.md b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/index.md new file mode 100644 index 00000000000..6c4cafa4b47 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/index.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.scheduler.jobscheduler](../index.md) / [JobSchedulerSyncScheduler](./index.md) + +# JobSchedulerSyncScheduler + +`class JobSchedulerSyncScheduler` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/scheduler/jobscheduler/JobSchedulerSyncScheduler.kt#L19) + +Class used to schedule sync of experiment +configuration from the server + +### Parameters + +`context` - context + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `JobSchedulerSyncScheduler(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`)`
Class used to schedule sync of experiment configuration from the server | + +### Functions + +| Name | Summary | +|---|---| +| [schedule](schedule.md) | `fun schedule(jobInfo: `[`JobInfo`](https://developer.android.com/reference/android/app/job/JobInfo.html)`): `[`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`](https://developer.android.com/reference/android/content/ComponentName.html)`): `[`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/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/schedule.md b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/schedule.md new file mode 100644 index 00000000000..5d2da113fa4 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-job-scheduler-sync-scheduler/schedule.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.scheduler.jobscheduler](../index.md) / [JobSchedulerSyncScheduler](index.md) / [schedule](./schedule.md) + +# schedule + +`fun schedule(jobInfo: `[`JobInfo`](https://developer.android.com/reference/android/app/job/JobInfo.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/scheduler/jobscheduler/JobSchedulerSyncScheduler.kt#L27) + +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`](https://developer.android.com/reference/android/content/ComponentName.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/scheduler/jobscheduler/JobSchedulerSyncScheduler.kt#L38) + +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/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/-init-.md b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/-init-.md new file mode 100644 index 00000000000..0e3a30f3ac7 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.scheduler.jobscheduler](../index.md) / [SyncJob](index.md) / [<init>](./-init-.md) + +# <init> + +`SyncJob()` + +JobScheduler job used to updating the list of experiments + diff --git a/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/get-fretboard.md b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/get-fretboard.md new file mode 100644 index 00000000000..c24d020ec3a --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/get-fretboard.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.scheduler.jobscheduler](../index.md) / [SyncJob](index.md) / [getFretboard](./get-fretboard.md) + +# getFretboard + +`abstract fun getFretboard(): `[`Fretboard`](../../mozilla.components.service.fretboard/-fretboard/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/scheduler/jobscheduler/SyncJob.kt#L42) + +Used to provide the instance of Fretboard +the app is using + +**Return** +current Fretboard instance + diff --git a/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/index.md b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/index.md new file mode 100644 index 00000000000..41ab43845b5 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/index.md @@ -0,0 +1,36 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.scheduler.jobscheduler](../index.md) / [SyncJob](./index.md) + +# SyncJob + +`abstract class SyncJob : `[`JobService`](https://developer.android.com/reference/android/app/job/JobService.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/scheduler/jobscheduler/SyncJob.kt#L15) + +JobScheduler job used to updating the list of experiments + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SyncJob()`
JobScheduler job used to updating the list of experiments | + +### Functions + +| Name | Summary | +|---|---| +| [getFretboard](get-fretboard.md) | `abstract fun getFretboard(): `[`Fretboard`](../../mozilla.components.service.fretboard/-fretboard/index.md)
Used to provide the instance of Fretboard the app is using | +| [onStartJob](on-start-job.md) | `open fun onStartJob(params: `[`JobParameters`](https://developer.android.com/reference/android/app/job/JobParameters.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onStopJob](on-stop-job.md) | `open fun onStopJob(params: `[`JobParameters`](https://developer.android.com/reference/android/app/job/JobParameters.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Extension Properties + +| Name | Summary | +|---|---| +| [appVersionName](../../mozilla.components.support.ktx.android.content/android.content.-context/app-version-name.md) | `val `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.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". | + +### Extension Functions + +| Name | Summary | +|---|---| +| [isOSOnLowMemory](../../mozilla.components.support.ktx.android.content/android.content.-context/is-o-s-on-low-memory.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.isOSOnLowMemory(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns whether or not the operating system is under low memory conditions. | +| [isPermissionGranted](../../mozilla.components.support.ktx.android.content/android.content.-context/is-permission-granted.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.isPermissionGranted(vararg permission: `[`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 if a list of permission have been granted, if all the permission have been granted returns true otherwise false. | +| [share](../../mozilla.components.support.ktx.android.content/android.content.-context/share.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.share(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, subject: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getString(R.string.mozac_support_ktx_share_dialog_title)): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Shares content via [ACTION_SEND](https://developer.android.com/reference/android/content/Intent.html#ACTION_SEND) intent. | +| [systemService](../../mozilla.components.support.ktx.android.content/android.content.-context/system-service.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.systemService(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](../../mozilla.components.support.ktx.android.content/android.content.-context/system-service.md#T)
Returns the handle to a system-level service by name. | diff --git a/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/on-start-job.md b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/on-start-job.md new file mode 100644 index 00000000000..4484ac7c135 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/on-start-job.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.scheduler.jobscheduler](../index.md) / [SyncJob](index.md) / [onStartJob](./on-start-job.md) + +# onStartJob + +`open fun onStartJob(params: `[`JobParameters`](https://developer.android.com/reference/android/app/job/JobParameters.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/scheduler/jobscheduler/SyncJob.kt#L18) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/on-stop-job.md b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/on-stop-job.md new file mode 100644 index 00000000000..2376c1e228d --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/-sync-job/on-stop-job.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.scheduler.jobscheduler](../index.md) / [SyncJob](index.md) / [onStopJob](./on-stop-job.md) + +# onStopJob + +`open fun onStopJob(params: `[`JobParameters`](https://developer.android.com/reference/android/app/job/JobParameters.html)`?): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/scheduler/jobscheduler/SyncJob.kt#L31) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/index.md b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/index.md new file mode 100644 index 00000000000..65cf9ae8e11 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.scheduler.jobscheduler/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.service.fretboard.scheduler.jobscheduler](./index.md) + +## Package mozilla.components.service.fretboard.scheduler.jobscheduler + +### Types + +| Name | Summary | +|---|---| +| [JobSchedulerSyncScheduler](-job-scheduler-sync-scheduler/index.md) | `class JobSchedulerSyncScheduler`
Class used to schedule sync of experiment configuration from the server | +| [SyncJob](-sync-job/index.md) | `abstract class SyncJob : `[`JobService`](https://developer.android.com/reference/android/app/job/JobService.html)
JobScheduler job used to updating the list of experiments | diff --git a/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-sync-worker/-init-.md b/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-sync-worker/-init-.md new file mode 100644 index 00000000000..8eb0f7f97c2 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-sync-worker/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.scheduler.workmanager](../index.md) / [SyncWorker](index.md) / [<init>](./-init-.md) + +# <init> + +`SyncWorker(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, params: WorkerParameters)` \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-sync-worker/do-work.md b/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-sync-worker/do-work.md new file mode 100644 index 00000000000..ccfc4ac8928 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-sync-worker/do-work.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.scheduler.workmanager](../index.md) / [SyncWorker](index.md) / [doWork](./do-work.md) + +# doWork + +`open fun doWork(): Result` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/scheduler/workmanager/SyncWorker.kt#L13) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-sync-worker/fretboard.md b/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-sync-worker/fretboard.md new file mode 100644 index 00000000000..ae155866834 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-sync-worker/fretboard.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.scheduler.workmanager](../index.md) / [SyncWorker](index.md) / [fretboard](./fretboard.md) + +# fretboard + +`abstract val fretboard: `[`Fretboard`](../../mozilla.components.service.fretboard/-fretboard/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/scheduler/workmanager/SyncWorker.kt#L23) + +Used to provide the instance of Fretboard +the app is using + +**Return** +current Fretboard instance + diff --git a/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-sync-worker/index.md b/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-sync-worker/index.md new file mode 100644 index 00000000000..91294ec8107 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-sync-worker/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.scheduler.workmanager](../index.md) / [SyncWorker](./index.md) + +# SyncWorker + +`abstract class SyncWorker : Worker` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/scheduler/workmanager/SyncWorker.kt#L12) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SyncWorker(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, params: WorkerParameters)` | + +### Properties + +| Name | Summary | +|---|---| +| [fretboard](fretboard.md) | `abstract val fretboard: `[`Fretboard`](../../mozilla.components.service.fretboard/-fretboard/index.md)
Used to provide the instance of Fretboard the app is using | + +### Functions + +| Name | Summary | +|---|---| +| [doWork](do-work.md) | `open fun doWork(): Result` | diff --git a/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-work-manager-sync-scheduler/-init-.md b/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-work-manager-sync-scheduler/-init-.md new file mode 100644 index 00000000000..a1959815184 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-work-manager-sync-scheduler/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.scheduler.workmanager](../index.md) / [WorkManagerSyncScheduler](index.md) / [<init>](./-init-.md) + +# <init> + +`WorkManagerSyncScheduler()` + +Class used to schedule sync of experiment +configuration from the server using WorkManager + diff --git a/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-work-manager-sync-scheduler/index.md b/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-work-manager-sync-scheduler/index.md new file mode 100644 index 00000000000..66f1032209f --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-work-manager-sync-scheduler/index.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.scheduler.workmanager](../index.md) / [WorkManagerSyncScheduler](./index.md) + +# WorkManagerSyncScheduler + +`class WorkManagerSyncScheduler` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/scheduler/workmanager/WorkManagerSyncScheduler.kt#L18) + +Class used to schedule sync of experiment +configuration from the server using WorkManager + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `WorkManagerSyncScheduler()`
Class used to schedule sync of experiment configuration from the server using WorkManager | + +### Functions + +| Name | Summary | +|---|---| +| [schedule](schedule.md) | `fun schedule(worker: `[`Class`](https://developer.android.com/reference/java/lang/Class.html)`, interval: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)`> = Pair(1, TimeUnit.DAYS)): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Schedule sync with the default constraints (once a day and charging) | diff --git a/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-work-manager-sync-scheduler/schedule.md b/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-work-manager-sync-scheduler/schedule.md new file mode 100644 index 00000000000..8f1b28b1f79 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/-work-manager-sync-scheduler/schedule.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.scheduler.workmanager](../index.md) / [WorkManagerSyncScheduler](index.md) / [schedule](./schedule.md) + +# schedule + +`fun schedule(worker: `[`Class`](https://developer.android.com/reference/java/lang/Class.html)`, interval: `[`Pair`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)`<`[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `[`TimeUnit`](https://developer.android.com/reference/java/util/concurrent/TimeUnit.html)`> = Pair(1, TimeUnit.DAYS)): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/scheduler/workmanager/WorkManagerSyncScheduler.kt#L25) + +Schedule sync with the default constraints +(once a day and charging) + +### Parameters + +`worker` - worker class \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/index.md b/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/index.md new file mode 100644 index 00000000000..9c079ee91a1 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.scheduler.workmanager/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.service.fretboard.scheduler.workmanager](./index.md) + +## Package mozilla.components.service.fretboard.scheduler.workmanager + +### Types + +| Name | Summary | +|---|---| +| [SyncWorker](-sync-worker/index.md) | `abstract class SyncWorker : Worker` | +| [WorkManagerSyncScheduler](-work-manager-sync-scheduler/index.md) | `class WorkManagerSyncScheduler`
Class used to schedule sync of experiment configuration from the server using WorkManager | diff --git a/docs/api/mozilla.components.service.fretboard.source.kinto/-http-client/get.md b/docs/api/mozilla.components.service.fretboard.source.kinto/-http-client/get.md new file mode 100644 index 00000000000..d47cfd74434 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.source.kinto/-http-client/get.md @@ -0,0 +1,18 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.source.kinto](../index.md) / [HttpClient](index.md) / [get](./get.md) + +# get + +`abstract fun get(url: `[`URL`](https://developer.android.com/reference/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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/source/kinto/HttpClient.kt#L24) + +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/mozilla.components.service.fretboard.source.kinto/-http-client/index.md b/docs/api/mozilla.components.service.fretboard.source.kinto/-http-client/index.md new file mode 100644 index 00000000000..a9027c43276 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.source.kinto/-http-client/index.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.source.kinto](../index.md) / [HttpClient](./index.md) + +# HttpClient + +`interface HttpClient` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/source/kinto/HttpClient.kt#L14) + +Represents an http client, used to +make it easy to swap implementations +as needed + +### Functions + +| Name | Summary | +|---|---| +| [get](get.md) | `abstract fun get(url: `[`URL`](https://developer.android.com/reference/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/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/-init-.md b/docs/api/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/-init-.md new file mode 100644 index 00000000000..349e395822c --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.source.kinto](../index.md) / [KintoExperimentSource](index.md) / [<init>](./-init-.md) + +# <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.md)` = HttpURLConnectionHttpClient())` + +Class responsible for fetching and +parsing experiments from a Kinto server + diff --git a/docs/api/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/get-experiments.md b/docs/api/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/get-experiments.md new file mode 100644 index 00000000000..18bf721ec03 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/get-experiments.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.source.kinto](../index.md) / [KintoExperimentSource](index.md) / [getExperiments](./get-experiments.md) + +# getExperiments + +`fun getExperiments(snapshot: `[`ExperimentsSnapshot`](../../mozilla.components.service.fretboard/-experiments-snapshot/index.md)`): `[`ExperimentsSnapshot`](../../mozilla.components.service.fretboard/-experiments-snapshot/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/source/kinto/KintoExperimentSource.kt#L33) + +Overrides [ExperimentSource.getExperiments](../../mozilla.components.service.fretboard/-experiment-source/get-experiments.md) + +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/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/index.md b/docs/api/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/index.md new file mode 100644 index 00000000000..d08c19b1ee1 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/index.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.source.kinto](../index.md) / [KintoExperimentSource](./index.md) + +# KintoExperimentSource + +`class KintoExperimentSource : `[`ExperimentSource`](../../mozilla.components.service.fretboard/-experiment-source/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/source/kinto/KintoExperimentSource.kt#L23) + +Class responsible for fetching and +parsing experiments from a Kinto server + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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.md)` = HttpURLConnectionHttpClient())`
Class responsible for fetching and parsing experiments from a Kinto server | + +### Functions + +| Name | Summary | +|---|---| +| [getExperiments](get-experiments.md) | `fun getExperiments(snapshot: `[`ExperimentsSnapshot`](../../mozilla.components.service.fretboard/-experiments-snapshot/index.md)`): `[`ExperimentsSnapshot`](../../mozilla.components.service.fretboard/-experiments-snapshot/index.md)
Requests new experiments from the source, parsing the response into experiments | diff --git a/docs/api/mozilla.components.service.fretboard.source.kinto/index.md b/docs/api/mozilla.components.service.fretboard.source.kinto/index.md new file mode 100644 index 00000000000..fae36bceaf5 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.source.kinto/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.service.fretboard.source.kinto](./index.md) + +## Package mozilla.components.service.fretboard.source.kinto + +### Types + +| Name | Summary | +|---|---| +| [HttpClient](-http-client/index.md) | `interface HttpClient`
Represents an http client, used to make it easy to swap implementations as needed | +| [KintoExperimentSource](-kinto-experiment-source/index.md) | `class KintoExperimentSource : `[`ExperimentSource`](../mozilla.components.service.fretboard/-experiment-source/index.md)
Class responsible for fetching and parsing experiments from a Kinto server | diff --git a/docs/api/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/-init-.md b/docs/api/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/-init-.md new file mode 100644 index 00000000000..3a3b15b37bc --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/-init-.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.storage.flatfile](../index.md) / [FlatFileExperimentStorage](index.md) / [<init>](./-init-.md) + +# <init> + +`FlatFileExperimentStorage(file: `[`File`](https://developer.android.com/reference/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/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/index.md b/docs/api/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/index.md new file mode 100644 index 00000000000..28e70ea6b77 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/index.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.storage.flatfile](../index.md) / [FlatFileExperimentStorage](./index.md) + +# FlatFileExperimentStorage + +`class FlatFileExperimentStorage : `[`ExperimentStorage`](../../mozilla.components.service.fretboard/-experiment-storage/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/storage/flatfile/FlatFileExperimentStorage.kt#L20) + +Class which uses a flat JSON file as an experiment storage mechanism + +### Parameters + +`file` - file where to store experiments + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FlatFileExperimentStorage(file: `[`File`](https://developer.android.com/reference/java/io/File.html)`)`
Class which uses a flat JSON file as an experiment storage mechanism | + +### Functions + +| Name | Summary | +|---|---| +| [retrieve](retrieve.md) | `fun retrieve(): `[`ExperimentsSnapshot`](../../mozilla.components.service.fretboard/-experiments-snapshot/index.md)
Reads experiments from disk | +| [save](save.md) | `fun save(snapshot: `[`ExperimentsSnapshot`](../../mozilla.components.service.fretboard/-experiments-snapshot/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stores the given experiments to disk | diff --git a/docs/api/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/retrieve.md b/docs/api/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/retrieve.md new file mode 100644 index 00000000000..f28b048b3e6 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/retrieve.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.storage.flatfile](../index.md) / [FlatFileExperimentStorage](index.md) / [retrieve](./retrieve.md) + +# retrieve + +`fun retrieve(): `[`ExperimentsSnapshot`](../../mozilla.components.service.fretboard/-experiments-snapshot/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/storage/flatfile/FlatFileExperimentStorage.kt#L23) + +Overrides [ExperimentStorage.retrieve](../../mozilla.components.service.fretboard/-experiment-storage/retrieve.md) + +Reads experiments from disk + +**Return** +experiments from disk + diff --git a/docs/api/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/save.md b/docs/api/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/save.md new file mode 100644 index 00000000000..f20314157ba --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/save.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard.storage.flatfile](../index.md) / [FlatFileExperimentStorage](index.md) / [save](./save.md) + +# save + +`fun save(snapshot: `[`ExperimentsSnapshot`](../../mozilla.components.service.fretboard/-experiments-snapshot/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/storage/flatfile/FlatFileExperimentStorage.kt#L36) + +Overrides [ExperimentStorage.save](../../mozilla.components.service.fretboard/-experiment-storage/save.md) + +Stores the given experiments to disk + +### Parameters + +`experiments` - list of experiments to store \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fretboard.storage.flatfile/index.md b/docs/api/mozilla.components.service.fretboard.storage.flatfile/index.md new file mode 100644 index 00000000000..9d0830a6c92 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard.storage.flatfile/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.service.fretboard.storage.flatfile](./index.md) + +## Package mozilla.components.service.fretboard.storage.flatfile + +### Types + +| Name | Summary | +|---|---| +| [FlatFileExperimentStorage](-flat-file-experiment-storage/index.md) | `class FlatFileExperimentStorage : `[`ExperimentStorage`](../mozilla.components.service.fretboard/-experiment-storage/index.md)
Class which uses a flat JSON file as an experiment storage mechanism | diff --git a/docs/api/mozilla.components.service.fretboard/-experiment-descriptor/-init-.md b/docs/api/mozilla.components.service.fretboard/-experiment-descriptor/-init-.md new file mode 100644 index 00000000000..3d384fcdff3 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-descriptor/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentDescriptor](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.service.fretboard/-experiment-descriptor/index.md b/docs/api/mozilla.components.service.fretboard/-experiment-descriptor/index.md new file mode 100644 index 00000000000..b55a967814f --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-descriptor/index.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentDescriptor](./index.md) + +# ExperimentDescriptor + +`data class ExperimentDescriptor` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentDescriptor.kt#L12) + +Class used to identify an experiment + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ExperimentDescriptor(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
Class used to identify an experiment | + +### Properties + +| Name | Summary | +|---|---| +| [name](name.md) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
experiment name | diff --git a/docs/api/mozilla.components.service.fretboard/-experiment-descriptor/name.md b/docs/api/mozilla.components.service.fretboard/-experiment-descriptor/name.md new file mode 100644 index 00000000000..03062499ee3 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-descriptor/name.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentDescriptor](index.md) / [name](./name.md) + +# name + +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentDescriptor.kt#L12) + +experiment name + +### Property + +`name` - experiment name \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fretboard/-experiment-download-exception/-init-.md b/docs/api/mozilla.components.service.fretboard/-experiment-download-exception/-init-.md new file mode 100644 index 00000000000..1eece34d6da --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-download-exception/-init-.md @@ -0,0 +1,6 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentDownloadException](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.service.fretboard/-experiment-download-exception/index.md b/docs/api/mozilla.components.service.fretboard/-experiment-download-exception/index.md new file mode 100644 index 00000000000..a87860cd2e4 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-download-exception/index.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentDownloadException](./index.md) + +# ExperimentDownloadException + +`class ExperimentDownloadException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentDownloadException.kt#L10) + +Exception while downloading experiments from the server + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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/mozilla.components.service.fretboard/-experiment-payload/-init-.md b/docs/api/mozilla.components.service.fretboard/-experiment-payload/-init-.md new file mode 100644 index 00000000000..c6573d7e4d4 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-payload/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentPayload](index.md) / [<init>](./-init-.md) + +# <init> + +`ExperimentPayload()` + +Class which represents an experiment associated data + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment-payload/get-boolean-list.md b/docs/api/mozilla.components.service.fretboard/-experiment-payload/get-boolean-list.md new file mode 100644 index 00000000000..9350070bd48 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-payload/get-boolean-list.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentPayload](index.md) / [getBooleanList](./get-boolean-list.md) + +# 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)`>?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentPayload.kt#L51) + +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/mozilla.components.service.fretboard/-experiment-payload/get-double-list.md b/docs/api/mozilla.components.service.fretboard/-experiment-payload/get-double-list.md new file mode 100644 index 00000000000..2e8021c00cb --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-payload/get-double-list.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentPayload](index.md) / [getDoubleList](./get-double-list.md) + +# 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)`>?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentPayload.kt#L87) + +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/mozilla.components.service.fretboard/-experiment-payload/get-int-list.md b/docs/api/mozilla.components.service.fretboard/-experiment-payload/get-int-list.md new file mode 100644 index 00000000000..ba53ee26895 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-payload/get-int-list.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentPayload](index.md) / [getIntList](./get-int-list.md) + +# 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)`>?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentPayload.kt#L63) + +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/mozilla.components.service.fretboard/-experiment-payload/get-keys.md b/docs/api/mozilla.components.service.fretboard/-experiment-payload/get-keys.md new file mode 100644 index 00000000000..ef96e3f8ddb --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-payload/get-keys.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentPayload](index.md) / [getKeys](./get-keys.md) + +# 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)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentPayload.kt#L39) + +Gets all the payload keys + +**Return** +set of payload keys + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment-payload/get-long-list.md b/docs/api/mozilla.components.service.fretboard/-experiment-payload/get-long-list.md new file mode 100644 index 00000000000..3723944e392 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-payload/get-long-list.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentPayload](index.md) / [getLongList](./get-long-list.md) + +# 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)`>?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentPayload.kt#L75) + +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/mozilla.components.service.fretboard/-experiment-payload/get-string-list.md b/docs/api/mozilla.components.service.fretboard/-experiment-payload/get-string-list.md new file mode 100644 index 00000000000..0fa77f88d13 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-payload/get-string-list.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentPayload](index.md) / [getStringList](./get-string-list.md) + +# 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)`>?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentPayload.kt#L99) + +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/mozilla.components.service.fretboard/-experiment-payload/get.md b/docs/api/mozilla.components.service.fretboard/-experiment-payload/get.md new file mode 100644 index 00000000000..e1c134ac54e --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-payload/get.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentPayload](index.md) / [get](./get.md) + +# 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)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentPayload.kt#L30) + +Gets a value from the payload + +### Parameters + +`key` - key + +**Return** +value under the specified key + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment-payload/index.md b/docs/api/mozilla.components.service.fretboard/-experiment-payload/index.md new file mode 100644 index 00000000000..e0b7c027d7d --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-payload/index.md @@ -0,0 +1,26 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentPayload](./index.md) + +# ExperimentPayload + +`class ExperimentPayload` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentPayload.kt#L10) + +Class which represents an experiment associated data + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ExperimentPayload()`
Class which represents an experiment associated data | + +### Functions + +| Name | Summary | +|---|---| +| [get](get.md) | `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.md) | `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.md) | `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.md) | `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.md) | `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.md) | `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.md) | `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.md) | `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/mozilla.components.service.fretboard/-experiment-payload/put.md b/docs/api/mozilla.components.service.fretboard/-experiment-payload/put.md new file mode 100644 index 00000000000..aabde478949 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-payload/put.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentPayload](index.md) / [put](./put.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentPayload.kt#L19) + +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/mozilla.components.service.fretboard/-experiment-source/get-experiments.md b/docs/api/mozilla.components.service.fretboard/-experiment-source/get-experiments.md new file mode 100644 index 00000000000..6ab8c7e7417 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-source/get-experiments.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentSource](index.md) / [getExperiments](./get-experiments.md) + +# getExperiments + +`abstract fun getExperiments(snapshot: `[`ExperimentsSnapshot`](../-experiments-snapshot/index.md)`): `[`ExperimentsSnapshot`](../-experiments-snapshot/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentSource.kt#L21) + +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/mozilla.components.service.fretboard/-experiment-source/index.md b/docs/api/mozilla.components.service.fretboard/-experiment-source/index.md new file mode 100644 index 00000000000..a924463a93b --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-source/index.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentSource](./index.md) + +# ExperimentSource + +`interface ExperimentSource` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentSource.kt#L11) + +Represents a location where experiments are stored +(Kinto, a JSON file on a server, etc) + +### Functions + +| Name | Summary | +|---|---| +| [getExperiments](get-experiments.md) | `abstract fun getExperiments(snapshot: `[`ExperimentsSnapshot`](../-experiments-snapshot/index.md)`): `[`ExperimentsSnapshot`](../-experiments-snapshot/index.md)
Requests new experiments from the source, parsing the response into experiments | + +### Inheritors + +| Name | Summary | +|---|---| +| [KintoExperimentSource](../../mozilla.components.service.fretboard.source.kinto/-kinto-experiment-source/index.md) | `class KintoExperimentSource : `[`ExperimentSource`](./index.md)
Class responsible for fetching and parsing experiments from a Kinto server | diff --git a/docs/api/mozilla.components.service.fretboard/-experiment-storage/index.md b/docs/api/mozilla.components.service.fretboard/-experiment-storage/index.md new file mode 100644 index 00000000000..cd01810104d --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-storage/index.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentStorage](./index.md) + +# ExperimentStorage + +`interface ExperimentStorage` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentStorage.kt#L11) + +Represents a location where experiments +are stored locally on the device + +### Functions + +| Name | Summary | +|---|---| +| [retrieve](retrieve.md) | `abstract fun retrieve(): `[`ExperimentsSnapshot`](../-experiments-snapshot/index.md)
Reads experiments from disk | +| [save](save.md) | `abstract fun save(snapshot: `[`ExperimentsSnapshot`](../-experiments-snapshot/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stores the given experiments to disk | + +### Inheritors + +| Name | Summary | +|---|---| +| [FlatFileExperimentStorage](../../mozilla.components.service.fretboard.storage.flatfile/-flat-file-experiment-storage/index.md) | `class FlatFileExperimentStorage : `[`ExperimentStorage`](./index.md)
Class which uses a flat JSON file as an experiment storage mechanism | diff --git a/docs/api/mozilla.components.service.fretboard/-experiment-storage/retrieve.md b/docs/api/mozilla.components.service.fretboard/-experiment-storage/retrieve.md new file mode 100644 index 00000000000..b60c6b85c99 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-storage/retrieve.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentStorage](index.md) / [retrieve](./retrieve.md) + +# retrieve + +`abstract fun retrieve(): `[`ExperimentsSnapshot`](../-experiments-snapshot/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentStorage.kt#L24) + +Reads experiments from disk + +**Return** +experiments from disk + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment-storage/save.md b/docs/api/mozilla.components.service.fretboard/-experiment-storage/save.md new file mode 100644 index 00000000000..2a7ab9939fc --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment-storage/save.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentStorage](index.md) / [save](./save.md) + +# save + +`abstract fun save(snapshot: `[`ExperimentsSnapshot`](../-experiments-snapshot/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentStorage.kt#L17) + +Stores the given experiments to disk + +### Parameters + +`experiments` - list of experiments to store \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/-bucket/-init-.md b/docs/api/mozilla.components.service.fretboard/-experiment/-bucket/-init-.md new file mode 100644 index 00000000000..bb73b367e39 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/-bucket/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.service.fretboard](../../index.md) / [Experiment](../index.md) / [Bucket](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.service.fretboard/-experiment/-bucket/index.md b/docs/api/mozilla.components.service.fretboard/-experiment/-bucket/index.md new file mode 100644 index 00000000000..f10ed0e987f --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/-bucket/index.md @@ -0,0 +1,18 @@ +[android-components](../../../index.md) / [mozilla.components.service.fretboard](../../index.md) / [Experiment](../index.md) / [Bucket](./index.md) + +# Bucket + +`data class Bucket` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L82) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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 + +| Name | Summary | +|---|---| +| [max](max.md) | `val max: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?`
Maximum bucket (exclusive), values from 0 to 100 | +| [min](min.md) | `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/mozilla.components.service.fretboard/-experiment/-bucket/max.md b/docs/api/mozilla.components.service.fretboard/-experiment/-bucket/max.md new file mode 100644 index 00000000000..b7b45dd9c08 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/-bucket/max.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.service.fretboard](../../index.md) / [Experiment](../index.md) / [Bucket](index.md) / [max](./max.md) + +# max + +`val max: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L86) + +Maximum bucket (exclusive), values from 0 to 100 + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/-bucket/min.md b/docs/api/mozilla.components.service.fretboard/-experiment/-bucket/min.md new file mode 100644 index 00000000000..bc221f797af --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/-bucket/min.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.service.fretboard](../../index.md) / [Experiment](../index.md) / [Bucket](index.md) / [min](./min.md) + +# min + +`val min: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L90) + +Minimum bucket (inclusive), values from 0 to 100 + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/-init-.md b/docs/api/mozilla.components.service.fretboard/-experiment/-init-.md new file mode 100644 index 00000000000..7a6f704d6bb --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/-init-.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Experiment](index.md) / [<init>](./-init-.md) + +# <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.md)`? = null, bucket: `[`Bucket`](-bucket/index.md)`? = null, lastModified: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`? = null, payload: `[`ExperimentPayload`](../-experiment-payload/index.md)`? = 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/mozilla.components.service.fretboard/-experiment/-matcher/-init-.md b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/-init-.md new file mode 100644 index 00000000000..874e5bded72 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.service.fretboard](../../index.md) / [Experiment](../index.md) / [Matcher](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.service.fretboard/-experiment/-matcher/app-id.md b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/app-id.md new file mode 100644 index 00000000000..90893878c97 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/app-id.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.service.fretboard](../../index.md) / [Experiment](../index.md) / [Matcher](index.md) / [appId](./app-id.md) + +# appId + +`val appId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L55) + +id (package name) of the expected application, as a regex + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/country.md b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/country.md new file mode 100644 index 00000000000..18566f9f7ac --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/country.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.service.fretboard](../../index.md) / [Experiment](../index.md) / [Matcher](index.md) / [country](./country.md) + +# country + +`val country: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L75) + +Required country, as a three-letter abbreviation + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/device.md b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/device.md new file mode 100644 index 00000000000..c3e71de69c4 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/device.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.service.fretboard](../../index.md) / [Experiment](../index.md) / [Matcher](index.md) / [device](./device.md) + +# device + +`val device: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L71) + +Required device model, as a regex + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/index.md b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/index.md new file mode 100644 index 00000000000..59a5ee56ec6 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/index.md @@ -0,0 +1,24 @@ +[android-components](../../../index.md) / [mozilla.components.service.fretboard](../../index.md) / [Experiment](../index.md) / [Matcher](./index.md) + +# Matcher + +`data class Matcher` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L47) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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 + +| Name | Summary | +|---|---| +| [appId](app-id.md) | `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.md) | `val country: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Required country, as a three-letter abbreviation | +| [device](device.md) | `val device: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Required device model, as a regex | +| [language](language.md) | `val language: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Language of the device, as a regex | +| [manufacturer](manufacturer.md) | `val manufacturer: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Required device manufacturer, as a regex | +| [regions](regions.md) | `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.md) | `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.md) | `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/mozilla.components.service.fretboard/-experiment/-matcher/language.md b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/language.md new file mode 100644 index 00000000000..f79682cd151 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/language.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.service.fretboard](../../index.md) / [Experiment](../index.md) / [Matcher](index.md) / [language](./language.md) + +# language + +`val language: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L51) + +Language of the device, as a regex + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/manufacturer.md b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/manufacturer.md new file mode 100644 index 00000000000..e0edadecd73 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/manufacturer.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.service.fretboard](../../index.md) / [Experiment](../index.md) / [Matcher](index.md) / [manufacturer](./manufacturer.md) + +# manufacturer + +`val manufacturer: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L67) + +Required device manufacturer, as a regex + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/regions.md b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/regions.md new file mode 100644 index 00000000000..3ae34ede8e4 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/regions.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.service.fretboard](../../index.md) / [Experiment](../index.md) / [Matcher](index.md) / [regions](./regions.md) + +# 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)`>?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L59) + +Regions where the experiment should be enabled + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/release-channel.md b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/release-channel.md new file mode 100644 index 00000000000..708584ac366 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/release-channel.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.service.fretboard](../../index.md) / [Experiment](../index.md) / [Matcher](index.md) / [releaseChannel](./release-channel.md) + +# releaseChannel + +`val releaseChannel: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L79) + +Required app release channel (alpha, beta, ...), as a regex + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/version.md b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/version.md new file mode 100644 index 00000000000..193940bea00 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/-matcher/version.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.service.fretboard](../../index.md) / [Experiment](../index.md) / [Matcher](index.md) / [version](./version.md) + +# version + +`val version: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L63) + +Required app version, as a regex + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/bucket.md b/docs/api/mozilla.components.service.fretboard/-experiment/bucket.md new file mode 100644 index 00000000000..737aaef9ed4 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/bucket.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Experiment](index.md) / [bucket](./bucket.md) + +# bucket + +`val bucket: `[`Bucket`](-bucket/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L32) + +Experiment buckets + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/description.md b/docs/api/mozilla.components.service.fretboard/-experiment/description.md new file mode 100644 index 00000000000..a1fa43472af --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/description.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Experiment](index.md) / [description](./description.md) + +# description + +`val description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L24) + +Detailed description of the experiment + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/equals.md b/docs/api/mozilla.components.service.fretboard/-experiment/equals.md new file mode 100644 index 00000000000..75b937bc790 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/equals.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Experiment](index.md) / [equals](./equals.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L98) + +Compares experiments by their id + +**Return** +true if the two experiments have the same id, false otherwise + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/hash-code.md b/docs/api/mozilla.components.service.fretboard/-experiment/hash-code.md new file mode 100644 index 00000000000..478a3e4ad38 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/hash-code.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Experiment](index.md) / [hashCode](./hash-code.md) + +# hashCode + +`fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L108) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/index.md b/docs/api/mozilla.components.service.fretboard/-experiment/index.md new file mode 100644 index 00000000000..2a9d1911262 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/index.md @@ -0,0 +1,41 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Experiment](./index.md) + +# Experiment + +`data class Experiment` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L12) + +Represents an A/B test experiment, +independent of the underlying +storage mechanism + +### Types + +| Name | Summary | +|---|---| +| [Bucket](-bucket/index.md) | `data class Bucket` | +| [Matcher](-matcher/index.md) | `data class Matcher` | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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.md)`? = null, bucket: `[`Bucket`](-bucket/index.md)`? = null, lastModified: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`? = null, payload: `[`ExperimentPayload`](../-experiment-payload/index.md)`? = 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 + +| Name | Summary | +|---|---| +| [bucket](bucket.md) | `val bucket: `[`Bucket`](-bucket/index.md)`?`
Experiment buckets | +| [description](description.md) | `val description: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Detailed description of the experiment | +| [lastModified](last-modified.md) | `val lastModified: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?`
Last modified date, as a UNIX timestamp | +| [match](match.md) | `val match: `[`Matcher`](-matcher/index.md)`?`
Filters for enabling the experiment | +| [name](name.md) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Human-readable name of the experiment | +| [payload](payload.md) | `val payload: `[`ExperimentPayload`](../-experiment-payload/index.md)`?`
Experiment associated metadata | +| [schema](schema.md) | `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 + +| Name | Summary | +|---|---| +| [equals](equals.md) | `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.md) | `fun hashCode(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/last-modified.md b/docs/api/mozilla.components.service.fretboard/-experiment/last-modified.md new file mode 100644 index 00000000000..5e0bee38f45 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/last-modified.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Experiment](index.md) / [lastModified](./last-modified.md) + +# lastModified + +`val lastModified: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L36) + +Last modified date, as a UNIX timestamp + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/match.md b/docs/api/mozilla.components.service.fretboard/-experiment/match.md new file mode 100644 index 00000000000..7b338971d00 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/match.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Experiment](index.md) / [match](./match.md) + +# match + +`val match: `[`Matcher`](-matcher/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L28) + +Filters for enabling the experiment + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/name.md b/docs/api/mozilla.components.service.fretboard/-experiment/name.md new file mode 100644 index 00000000000..f3a7bc8720b --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/name.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Experiment](index.md) / [name](./name.md) + +# name + +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L20) + +Human-readable name of the experiment + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/payload.md b/docs/api/mozilla.components.service.fretboard/-experiment/payload.md new file mode 100644 index 00000000000..a1e6941fced --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/payload.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Experiment](index.md) / [payload](./payload.md) + +# payload + +`val payload: `[`ExperimentPayload`](../-experiment-payload/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L40) + +Experiment associated metadata + diff --git a/docs/api/mozilla.components.service.fretboard/-experiment/schema.md b/docs/api/mozilla.components.service.fretboard/-experiment/schema.md new file mode 100644 index 00000000000..a639b39c247 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiment/schema.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Experiment](index.md) / [schema](./schema.md) + +# schema + +`val schema: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Experiment.kt#L45) + +Last time the experiment schema was modified +(as a UNIX timestamp) + diff --git a/docs/api/mozilla.components.service.fretboard/-experiments-snapshot/-init-.md b/docs/api/mozilla.components.service.fretboard/-experiments-snapshot/-init-.md new file mode 100644 index 00000000000..1f6c4191fba --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiments-snapshot/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentsSnapshot](index.md) / [<init>](./-init-.md) + +# <init> + +`ExperimentsSnapshot(experiments: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Experiment`](../-experiment/index.md)`>, lastModified: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?)` + +Represents an experiment sync result + diff --git a/docs/api/mozilla.components.service.fretboard/-experiments-snapshot/experiments.md b/docs/api/mozilla.components.service.fretboard/-experiments-snapshot/experiments.md new file mode 100644 index 00000000000..72937c42846 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiments-snapshot/experiments.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentsSnapshot](index.md) / [experiments](./experiments.md) + +# experiments + +`val experiments: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Experiment`](../-experiment/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentsSnapshot.kt#L14) + +Downloaded list of experiments + diff --git a/docs/api/mozilla.components.service.fretboard/-experiments-snapshot/index.md b/docs/api/mozilla.components.service.fretboard/-experiments-snapshot/index.md new file mode 100644 index 00000000000..81ad52b943e --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiments-snapshot/index.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentsSnapshot](./index.md) + +# ExperimentsSnapshot + +`data class ExperimentsSnapshot` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentsSnapshot.kt#L10) + +Represents an experiment sync result + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ExperimentsSnapshot(experiments: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Experiment`](../-experiment/index.md)`>, lastModified: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?)`
Represents an experiment sync result | + +### Properties + +| Name | Summary | +|---|---| +| [experiments](experiments.md) | `val experiments: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Experiment`](../-experiment/index.md)`>`
Downloaded list of experiments | +| [lastModified](last-modified.md) | `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/mozilla.components.service.fretboard/-experiments-snapshot/last-modified.md b/docs/api/mozilla.components.service.fretboard/-experiments-snapshot/last-modified.md new file mode 100644 index 00000000000..140c689cd2a --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-experiments-snapshot/last-modified.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ExperimentsSnapshot](index.md) / [lastModified](./last-modified.md) + +# lastModified + +`val lastModified: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ExperimentsSnapshot.kt#L18) + +Last time experiments were modified on the server, as a UNIX timestamp + diff --git a/docs/api/mozilla.components.service.fretboard/-fretboard/-init-.md b/docs/api/mozilla.components.service.fretboard/-fretboard/-init-.md new file mode 100644 index 00000000000..5762aee63a0 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-fretboard/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Fretboard](index.md) / [<init>](./-init-.md) + +# <init> + +`Fretboard(source: `[`ExperimentSource`](../-experiment-source/index.md)`, storage: `[`ExperimentStorage`](../-experiment-storage/index.md)`, valuesProvider: `[`ValuesProvider`](../-values-provider/index.md)` = ValuesProvider())` + +Entry point of the library + diff --git a/docs/api/mozilla.components.service.fretboard/-fretboard/clear-all-overrides-now.md b/docs/api/mozilla.components.service.fretboard/-fretboard/clear-all-overrides-now.md new file mode 100644 index 00000000000..95b7596abd2 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-fretboard/clear-all-overrides-now.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Fretboard](index.md) / [clearAllOverridesNow](./clear-all-overrides-now.md) + +# clearAllOverridesNow + +`fun clearAllOverridesNow(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Fretboard.kt#L184) + +Clears all experiment overrides as a blocking operation + +### Exceptions + +`IllegalArgumentException` - when called from the main thread + +### Parameters + +`context` - context \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fretboard/-fretboard/clear-all-overrides.md b/docs/api/mozilla.components.service.fretboard/-fretboard/clear-all-overrides.md new file mode 100644 index 00000000000..e263baf24fe --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-fretboard/clear-all-overrides.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Fretboard](index.md) / [clearAllOverrides](./clear-all-overrides.md) + +# clearAllOverrides + +`fun clearAllOverrides(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Fretboard.kt#L174) + +Clears all experiment overrides asynchronously + +### Parameters + +`context` - context \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fretboard/-fretboard/clear-override-now.md b/docs/api/mozilla.components.service.fretboard/-fretboard/clear-override-now.md new file mode 100644 index 00000000000..c090088ab03 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-fretboard/clear-override-now.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Fretboard](index.md) / [clearOverrideNow](./clear-override-now.md) + +# clearOverrideNow + +`fun clearOverrideNow(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Fretboard.kt#L165) + +Clears an override for a specified experiment as a blocking operation + +### Exceptions + +`IllegalArgumentException` - when called from the main thread + +### Parameters + +`context` - context + +`descriptor` - descriptor of the experiment \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fretboard/-fretboard/clear-override.md b/docs/api/mozilla.components.service.fretboard/-fretboard/clear-override.md new file mode 100644 index 00000000000..0f1dd003840 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-fretboard/clear-override.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Fretboard](index.md) / [clearOverride](./clear-override.md) + +# clearOverride + +`fun clearOverride(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Fretboard.kt#L153) + +Clears an override for a specified experiment asynchronously + +### Parameters + +`context` - context + +`descriptor` - descriptor of the experiment \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fretboard/-fretboard/experiments.md b/docs/api/mozilla.components.service.fretboard/-fretboard/experiments.md new file mode 100644 index 00000000000..9e0ef8b3af1 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-fretboard/experiments.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Fretboard](index.md) / [experiments](./experiments.md) + +# experiments + +`val experiments: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Experiment`](../-experiment/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Fretboard.kt#L31) + +Provides the list of experiments (active or not) + diff --git a/docs/api/mozilla.components.service.fretboard/-fretboard/get-active-experiments.md b/docs/api/mozilla.components.service.fretboard/-fretboard/get-active-experiments.md new file mode 100644 index 00000000000..9a410b9e2cc --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-fretboard/get-active-experiments.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Fretboard](index.md) / [getActiveExperiments](./get-active-experiments.md) + +# getActiveExperiments + +`fun getActiveExperiments(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Experiment`](../-experiment/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Fretboard.kt#L106) + +Provides the list of active experiments + +### Parameters + +`context` - context + +**Return** +active experiments + diff --git a/docs/api/mozilla.components.service.fretboard/-fretboard/get-experiment.md b/docs/api/mozilla.components.service.fretboard/-fretboard/get-experiment.md new file mode 100644 index 00000000000..7e7b784f71e --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-fretboard/get-experiment.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Fretboard](index.md) / [getExperiment](./get-experiment.md) + +# getExperiment + +`fun getExperiment(descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.md)`): `[`Experiment`](../-experiment/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Fretboard.kt#L95) + +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/mozilla.components.service.fretboard/-fretboard/get-experiments-map.md b/docs/api/mozilla.components.service.fretboard/-fretboard/get-experiments-map.md new file mode 100644 index 00000000000..d17c95620be --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-fretboard/get-experiments-map.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Fretboard](index.md) / [getExperimentsMap](./get-experiments-map.md) + +# getExperimentsMap + +`fun getExperimentsMap(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`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)`, `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Fretboard.kt#L117) + +Provides a map of active/inactive experiments + +### Parameters + +`context` - context + +**Return** +map of experiments to A/B state + diff --git a/docs/api/mozilla.components.service.fretboard/-fretboard/get-user-bucket.md b/docs/api/mozilla.components.service.fretboard/-fretboard/get-user-bucket.md new file mode 100644 index 00000000000..5cade42a595 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-fretboard/get-user-bucket.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Fretboard](index.md) / [getUserBucket](./get-user-bucket.md) + +# getUserBucket + +`fun getUserBucket(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Fretboard.kt#L194) + +Returns the user bucket number used to determine whether the user +is in or out of the experiment + +### Parameters + +`context` - context \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fretboard/-fretboard/index.md b/docs/api/mozilla.components.service.fretboard/-fretboard/index.md new file mode 100644 index 00000000000..d1aaee3b3c8 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-fretboard/index.md @@ -0,0 +1,38 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Fretboard](./index.md) + +# Fretboard + +`class Fretboard` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Fretboard.kt#L18) + +Entry point of the library + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Fretboard(source: `[`ExperimentSource`](../-experiment-source/index.md)`, storage: `[`ExperimentStorage`](../-experiment-storage/index.md)`, valuesProvider: `[`ValuesProvider`](../-values-provider/index.md)` = ValuesProvider())`
Entry point of the library | + +### Properties + +| Name | Summary | +|---|---| +| [experiments](experiments.md) | `val experiments: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Experiment`](../-experiment/index.md)`>`
Provides the list of experiments (active or not) | + +### Functions + +| Name | Summary | +|---|---| +| [clearAllOverrides](clear-all-overrides.md) | `fun clearAllOverrides(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Clears all experiment overrides asynchronously | +| [clearAllOverridesNow](clear-all-overrides-now.md) | `fun clearAllOverridesNow(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Clears all experiment overrides as a blocking operation | +| [clearOverride](clear-override.md) | `fun clearOverride(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Clears an override for a specified experiment asynchronously | +| [clearOverrideNow](clear-override-now.md) | `fun clearOverrideNow(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Clears an override for a specified experiment as a blocking operation | +| [getActiveExperiments](get-active-experiments.md) | `fun getActiveExperiments(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`Experiment`](../-experiment/index.md)`>`
Provides the list of active experiments | +| [getExperiment](get-experiment.md) | `fun getExperiment(descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.md)`): `[`Experiment`](../-experiment/index.md)`?`
Gets the metadata associated with the specified experiment, even if the user is not part of it | +| [getExperimentsMap](get-experiments-map.md) | `fun getExperimentsMap(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`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)`, `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>`
Provides a map of active/inactive experiments | +| [getUserBucket](get-user-bucket.md) | `fun getUserBucket(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns the user bucket number used to determine whether the user is in or out of the experiment | +| [isInExperiment](is-in-experiment.md) | `fun isInExperiment(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.md)`): `[`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.md) | `fun loadExperiments(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Loads experiments from local storage | +| [setOverride](set-override.md) | `fun setOverride(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.md)`, 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 asynchronously | +| [setOverrideNow](set-override-now.md) | `fun setOverrideNow(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.md)`, 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 as a blocking operation | +| [updateExperiments](update-experiments.md) | `fun updateExperiments(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Requests new experiments from the server and saves them to local storage | +| [withExperiment](with-experiment.md) | `fun withExperiment(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.md)`, block: (`[`Experiment`](../-experiment/index.md)`) -> `[`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/mozilla.components.service.fretboard/-fretboard/is-in-experiment.md b/docs/api/mozilla.components.service.fretboard/-fretboard/is-in-experiment.md new file mode 100644 index 00000000000..26fc22eb97a --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-fretboard/is-in-experiment.md @@ -0,0 +1,18 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Fretboard](index.md) / [isInExperiment](./is-in-experiment.md) + +# isInExperiment + +`fun isInExperiment(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Fretboard.kt#L73) + +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/mozilla.components.service.fretboard/-fretboard/load-experiments.md b/docs/api/mozilla.components.service.fretboard/-fretboard/load-experiments.md new file mode 100644 index 00000000000..9bad80652d4 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-fretboard/load-experiments.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Fretboard](index.md) / [loadExperiments](./load-experiments.md) + +# loadExperiments + +`@Synchronized fun loadExperiments(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Fretboard.kt#L38) + +Loads experiments from local storage + diff --git a/docs/api/mozilla.components.service.fretboard/-fretboard/set-override-now.md b/docs/api/mozilla.components.service.fretboard/-fretboard/set-override-now.md new file mode 100644 index 00000000000..0c857de006c --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-fretboard/set-override-now.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Fretboard](index.md) / [setOverrideNow](./set-override-now.md) + +# setOverrideNow + +`fun setOverrideNow(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Fretboard.kt#L143) + +Overrides a specified experiment as a blocking operation + +### Exceptions + +`IllegalArgumentException` - when called from the main thread + +### 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/mozilla.components.service.fretboard/-fretboard/set-override.md b/docs/api/mozilla.components.service.fretboard/-fretboard/set-override.md new file mode 100644 index 00000000000..6bfbefc046f --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-fretboard/set-override.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Fretboard](index.md) / [setOverride](./set-override.md) + +# setOverride + +`fun setOverride(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Fretboard.kt#L131) + +Overrides a specified experiment asynchronously + +### 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/mozilla.components.service.fretboard/-fretboard/update-experiments.md b/docs/api/mozilla.components.service.fretboard/-fretboard/update-experiments.md new file mode 100644 index 00000000000..c716327fe7c --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-fretboard/update-experiments.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Fretboard](index.md) / [updateExperiments](./update-experiments.md) + +# updateExperiments + +`@Synchronized fun updateExperiments(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Fretboard.kt#L48) + +Requests new experiments from the server and +saves them to local storage + diff --git a/docs/api/mozilla.components.service.fretboard/-fretboard/with-experiment.md b/docs/api/mozilla.components.service.fretboard/-fretboard/with-experiment.md new file mode 100644 index 00000000000..56b733518ba --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-fretboard/with-experiment.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [Fretboard](index.md) / [withExperiment](./with-experiment.md) + +# withExperiment + +`fun withExperiment(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, descriptor: `[`ExperimentDescriptor`](../-experiment-descriptor/index.md)`, block: (`[`Experiment`](../-experiment/index.md)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/Fretboard.kt#L84) + +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/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/-init-.md b/docs/api/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/-init-.md new file mode 100644 index 00000000000..85d9104567d --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [JSONExperimentParser](index.md) / [<init>](./-init-.md) + +# <init> + +`JSONExperimentParser()` + +Default JSON parsing implementation + diff --git a/docs/api/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/from-json.md b/docs/api/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/from-json.md new file mode 100644 index 00000000000..712c8ecb465 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/from-json.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [JSONExperimentParser](index.md) / [fromJson](./from-json.md) + +# fromJson + +`fun fromJson(jsonObject: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`Experiment`](../-experiment/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/JSONExperimentParser.kt#L26) + +Creates an experiment from its json representation + +### Parameters + +`jsonObject` - experiment json object + +**Return** +created experiment + diff --git a/docs/api/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/index.md b/docs/api/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/index.md new file mode 100644 index 00000000000..b2c640ddf51 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/index.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [JSONExperimentParser](./index.md) + +# JSONExperimentParser + +`class JSONExperimentParser` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/JSONExperimentParser.kt#L19) + +Default JSON parsing implementation + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `JSONExperimentParser()`
Default JSON parsing implementation | + +### Functions + +| Name | Summary | +|---|---| +| [fromJson](from-json.md) | `fun fromJson(jsonObject: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`Experiment`](../-experiment/index.md)
Creates an experiment from its json representation | +| [toJson](to-json.md) | `fun toJson(experiment: `[`Experiment`](../-experiment/index.md)`): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)
Converts the specified experiment to json | diff --git a/docs/api/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/to-json.md b/docs/api/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/to-json.md new file mode 100644 index 00000000000..c54a085baaf --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-j-s-o-n-experiment-parser/to-json.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [JSONExperimentParser](index.md) / [toJson](./to-json.md) + +# toJson + +`fun toJson(experiment: `[`Experiment`](../-experiment/index.md)`): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/JSONExperimentParser.kt#L63) + +Converts the specified experiment to json + +### Parameters + +`experiment` - experiment to convert + +**Return** +json representation of the experiment + diff --git a/docs/api/mozilla.components.service.fretboard/-values-provider/-init-.md b/docs/api/mozilla.components.service.fretboard/-values-provider/-init-.md new file mode 100644 index 00000000000..abeaecd462e --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-values-provider/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ValuesProvider](index.md) / [<init>](./-init-.md) + +# <init> + +`ValuesProvider()` + +Class used to provide +custom filter values + diff --git a/docs/api/mozilla.components.service.fretboard/-values-provider/get-app-id.md b/docs/api/mozilla.components.service.fretboard/-values-provider/get-app-id.md new file mode 100644 index 00000000000..89e3b6bc9a4 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-values-provider/get-app-id.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ValuesProvider](index.md) / [getAppId](./get-app-id.md) + +# getAppId + +`open fun getAppId(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ValuesProvider.kt#L35) + +Provides the app id (package name) + +**Return** +app id (package name) + diff --git a/docs/api/mozilla.components.service.fretboard/-values-provider/get-client-id.md b/docs/api/mozilla.components.service.fretboard/-values-provider/get-client-id.md new file mode 100644 index 00000000000..b03dd2603d9 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-values-provider/get-client-id.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ValuesProvider](index.md) / [getClientId](./get-client-id.md) + +# getClientId + +`open fun getClientId(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ValuesProvider.kt#L100) + +Provides the client ID (UUID) used for bucketing the users. + diff --git a/docs/api/mozilla.components.service.fretboard/-values-provider/get-country.md b/docs/api/mozilla.components.service.fretboard/-values-provider/get-country.md new file mode 100644 index 00000000000..97884857989 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-values-provider/get-country.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ValuesProvider](index.md) / [getCountry](./get-country.md) + +# getCountry + +`open fun getCountry(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ValuesProvider.kt#L80) + +Provides the user's country + +**Return** +user's country, as a three-letter abbreviation + diff --git a/docs/api/mozilla.components.service.fretboard/-values-provider/get-device.md b/docs/api/mozilla.components.service.fretboard/-values-provider/get-device.md new file mode 100644 index 00000000000..649463c8d1a --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-values-provider/get-device.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ValuesProvider](index.md) / [getDevice](./get-device.md) + +# getDevice + +`open fun getDevice(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ValuesProvider.kt#L71) + +Provides the device model + +**Return** +device model + diff --git a/docs/api/mozilla.components.service.fretboard/-values-provider/get-language.md b/docs/api/mozilla.components.service.fretboard/-values-provider/get-language.md new file mode 100644 index 00000000000..7047a465b97 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-values-provider/get-language.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ValuesProvider](index.md) / [getLanguage](./get-language.md) + +# getLanguage + +`open fun getLanguage(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ValuesProvider.kt#L22) + +Provides the user's language + +**Return** +user's language as a three-letter abbreviation + diff --git a/docs/api/mozilla.components.service.fretboard/-values-provider/get-manufacturer.md b/docs/api/mozilla.components.service.fretboard/-values-provider/get-manufacturer.md new file mode 100644 index 00000000000..26f9cd35a73 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-values-provider/get-manufacturer.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ValuesProvider](index.md) / [getManufacturer](./get-manufacturer.md) + +# getManufacturer + +`open fun getManufacturer(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ValuesProvider.kt#L62) + +Provides the device manufacturer + +**Return** +device manufacturer + diff --git a/docs/api/mozilla.components.service.fretboard/-values-provider/get-region.md b/docs/api/mozilla.components.service.fretboard/-values-provider/get-region.md new file mode 100644 index 00000000000..06b04abc244 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-values-provider/get-region.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ValuesProvider](index.md) / [getRegion](./get-region.md) + +# getRegion + +`open fun getRegion(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ValuesProvider.kt#L44) + +Provides the user's region + +**Return** +user's region as a three-letter abbreviation + diff --git a/docs/api/mozilla.components.service.fretboard/-values-provider/get-release-channel.md b/docs/api/mozilla.components.service.fretboard/-values-provider/get-release-channel.md new file mode 100644 index 00000000000..76cba2e2f67 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-values-provider/get-release-channel.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ValuesProvider](index.md) / [getReleaseChannel](./get-release-channel.md) + +# getReleaseChannel + +`open fun getReleaseChannel(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ValuesProvider.kt#L93) + +Provides the app's release channel (alpha, beta, ...) + +**Return** +release channel of the app + diff --git a/docs/api/mozilla.components.service.fretboard/-values-provider/get-version.md b/docs/api/mozilla.components.service.fretboard/-values-provider/get-version.md new file mode 100644 index 00000000000..93e5aadbe1d --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-values-provider/get-version.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ValuesProvider](index.md) / [getVersion](./get-version.md) + +# getVersion + +`open fun getVersion(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ValuesProvider.kt#L53) + +Provides the app version + +**Return** +app version name + diff --git a/docs/api/mozilla.components.service.fretboard/-values-provider/index.md b/docs/api/mozilla.components.service.fretboard/-values-provider/index.md new file mode 100644 index 00000000000..5485b27c70b --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/-values-provider/index.md @@ -0,0 +1,28 @@ +[android-components](../../index.md) / [mozilla.components.service.fretboard](../index.md) / [ValuesProvider](./index.md) + +# ValuesProvider + +`open class ValuesProvider` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/fretboard/src/main/java/mozilla/components/service/fretboard/ValuesProvider.kt#L16) + +Class used to provide +custom filter values + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ValuesProvider()`
Class used to provide custom filter values | + +### Functions + +| Name | Summary | +|---|---| +| [getAppId](get-app-id.md) | `open fun getAppId(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Provides the app id (package name) | +| [getClientId](get-client-id.md) | `open fun getClientId(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Provides the client ID (UUID) used for bucketing the users. | +| [getCountry](get-country.md) | `open fun getCountry(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Provides the user's country | +| [getDevice](get-device.md) | `open fun getDevice(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Provides the device model | +| [getLanguage](get-language.md) | `open fun getLanguage(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Provides the user's language | +| [getManufacturer](get-manufacturer.md) | `open fun getManufacturer(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Provides the device manufacturer | +| [getRegion](get-region.md) | `open fun getRegion(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Provides the user's region | +| [getReleaseChannel](get-release-channel.md) | `open fun getReleaseChannel(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Provides the app's release channel (alpha, beta, ...) | +| [getVersion](get-version.md) | `open fun getVersion(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Provides the app version | diff --git a/docs/api/mozilla.components.service.fretboard/index.md b/docs/api/mozilla.components.service.fretboard/index.md new file mode 100644 index 00000000000..0ad9b439ee8 --- /dev/null +++ b/docs/api/mozilla.components.service.fretboard/index.md @@ -0,0 +1,23 @@ +[android-components](../index.md) / [mozilla.components.service.fretboard](./index.md) + +## Package mozilla.components.service.fretboard + +### Types + +| Name | Summary | +|---|---| +| [Experiment](-experiment/index.md) | `data class Experiment`
Represents an A/B test experiment, independent of the underlying storage mechanism | +| [ExperimentDescriptor](-experiment-descriptor/index.md) | `data class ExperimentDescriptor`
Class used to identify an experiment | +| [ExperimentPayload](-experiment-payload/index.md) | `class ExperimentPayload`
Class which represents an experiment associated data | +| [ExperimentSource](-experiment-source/index.md) | `interface ExperimentSource`
Represents a location where experiments are stored (Kinto, a JSON file on a server, etc) | +| [ExperimentStorage](-experiment-storage/index.md) | `interface ExperimentStorage`
Represents a location where experiments are stored locally on the device | +| [ExperimentsSnapshot](-experiments-snapshot/index.md) | `data class ExperimentsSnapshot`
Represents an experiment sync result | +| [Fretboard](-fretboard/index.md) | `class Fretboard`
Entry point of the library | +| [JSONExperimentParser](-j-s-o-n-experiment-parser/index.md) | `class JSONExperimentParser`
Default JSON parsing implementation | +| [ValuesProvider](-values-provider/index.md) | `open class ValuesProvider`
Class used to provide custom filter values | + +### Exceptions + +| Name | Summary | +|---|---| +| [ExperimentDownloadException](-experiment-download-exception/index.md) | `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/mozilla.components.service.fxa/-access-token-info/-init-.md b/docs/api/mozilla.components.service.fxa/-access-token-info/-init-.md new file mode 100644 index 00000000000..45b533e1dbc --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-access-token-info/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccessTokenInfo](index.md) / [<init>](./-init-.md) + +# <init> + +`AccessTokenInfo(token: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, key: `[`OAuthScopedKey`](../-o-auth-scoped-key/index.md)`?, expiresAt: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`)` + +The result of authentication with FxA via an OAuth flow. + diff --git a/docs/api/mozilla.components.service.fxa/-access-token-info/expires-at.md b/docs/api/mozilla.components.service.fxa/-access-token-info/expires-at.md new file mode 100644 index 00000000000..c2386947236 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-access-token-info/expires-at.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccessTokenInfo](index.md) / [expiresAt](./expires-at.md) + +# expiresAt + +`val expiresAt: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccessTokenInfo.kt#L31) + +The expiry date timestamp of this token since unix epoch (in seconds). + +### Property + +`expiresAt` - The expiry date timestamp of this token since unix epoch (in seconds). \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-access-token-info/index.md b/docs/api/mozilla.components.service.fxa/-access-token-info/index.md new file mode 100644 index 00000000000..f65db996d56 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-access-token-info/index.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccessTokenInfo](./index.md) + +# AccessTokenInfo + +`data class AccessTokenInfo` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccessTokenInfo.kt#L28) + +The result of authentication with FxA via an OAuth flow. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AccessTokenInfo(token: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, key: `[`OAuthScopedKey`](../-o-auth-scoped-key/index.md)`?, expiresAt: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`)`
The result of authentication with FxA via an OAuth flow. | + +### Properties + +| Name | Summary | +|---|---| +| [expiresAt](expires-at.md) | `val expiresAt: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
The expiry date timestamp of this token since unix epoch (in seconds). | +| [key](key.md) | `val key: `[`OAuthScopedKey`](../-o-auth-scoped-key/index.md)`?`
An OAuthScopedKey if present. | +| [token](token.md) | `val token: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The access token produced by the flow. | diff --git a/docs/api/mozilla.components.service.fxa/-access-token-info/key.md b/docs/api/mozilla.components.service.fxa/-access-token-info/key.md new file mode 100644 index 00000000000..c27b35455ce --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-access-token-info/key.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccessTokenInfo](index.md) / [key](./key.md) + +# key + +`val key: `[`OAuthScopedKey`](../-o-auth-scoped-key/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccessTokenInfo.kt#L30) + +An OAuthScopedKey if present. + +### Property + +`key` - An OAuthScopedKey if present. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-access-token-info/token.md b/docs/api/mozilla.components.service.fxa/-access-token-info/token.md new file mode 100644 index 00000000000..9430cd463f1 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-access-token-info/token.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccessTokenInfo](index.md) / [token](./token.md) + +# token + +`val token: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccessTokenInfo.kt#L29) + +The access token produced by the flow. + +### Property + +`token` - The access token produced by the flow. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-account-observer/index.md b/docs/api/mozilla.components.service.fxa/-account-observer/index.md new file mode 100644 index 00000000000..81f4e915b96 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-account-observer/index.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccountObserver](./index.md) + +# AccountObserver + +`interface AccountObserver` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L92) + +Observer interface which lets its users monitor account state changes and major events. + +### Functions + +| Name | Summary | +|---|---| +| [onAuthenticated](on-authenticated.md) | `abstract fun onAuthenticated(account: `[`FirefoxAccountShaped`](../-firefox-account-shaped/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Account was successfully authenticated. | +| [onError](on-error.md) | `abstract fun onError(error: `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Account manager encountered an error. Inspect [error](on-error.md#mozilla.components.service.fxa.AccountObserver$onError(java.lang.Exception)/error) for details. | +| [onLoggedOut](on-logged-out.md) | `abstract fun onLoggedOut(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Account just got logged out. | +| [onProfileUpdated](on-profile-updated.md) | `abstract fun onProfileUpdated(profile: `[`Profile`](../-profile/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Account's profile is now available. | diff --git a/docs/api/mozilla.components.service.fxa/-account-observer/on-authenticated.md b/docs/api/mozilla.components.service.fxa/-account-observer/on-authenticated.md new file mode 100644 index 00000000000..db595d1e20d --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-account-observer/on-authenticated.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccountObserver](index.md) / [onAuthenticated](./on-authenticated.md) + +# onAuthenticated + +`abstract fun onAuthenticated(account: `[`FirefoxAccountShaped`](../-firefox-account-shaped/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L102) + +Account was successfully authenticated. + +### Parameters + +`account` - An authenticated instance of a [FirefoxAccountShaped](../-firefox-account-shaped/index.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-account-observer/on-error.md b/docs/api/mozilla.components.service.fxa/-account-observer/on-error.md new file mode 100644 index 00000000000..2ffe904b417 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-account-observer/on-error.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccountObserver](index.md) / [onError](./on-error.md) + +# onError + +`abstract fun onError(error: `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L114) + +Account manager encountered an error. Inspect [error](on-error.md#mozilla.components.service.fxa.AccountObserver$onError(java.lang.Exception)/error) for details. + +### Parameters + +`error` - A specific error encountered. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-account-observer/on-logged-out.md b/docs/api/mozilla.components.service.fxa/-account-observer/on-logged-out.md new file mode 100644 index 00000000000..3ecda4c5a50 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-account-observer/on-logged-out.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccountObserver](index.md) / [onLoggedOut](./on-logged-out.md) + +# onLoggedOut + +`abstract fun onLoggedOut(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L96) + +Account just got logged out. + diff --git a/docs/api/mozilla.components.service.fxa/-account-observer/on-profile-updated.md b/docs/api/mozilla.components.service.fxa/-account-observer/on-profile-updated.md new file mode 100644 index 00000000000..7fe9890ea85 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-account-observer/on-profile-updated.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccountObserver](index.md) / [onProfileUpdated](./on-profile-updated.md) + +# onProfileUpdated + +`abstract fun onProfileUpdated(profile: `[`Profile`](../-profile/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L108) + +Account's profile is now available. + +### Parameters + +`profile` - A fresh version of account's [Profile](../-profile/index.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-account-state/-authenticated-no-profile.md b/docs/api/mozilla.components.service.fxa/-account-state/-authenticated-no-profile.md new file mode 100644 index 00000000000..c436165e22a --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-account-state/-authenticated-no-profile.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccountState](index.md) / [AuthenticatedNoProfile](./-authenticated-no-profile.md) + +# AuthenticatedNoProfile + +`AuthenticatedNoProfile` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L27) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-account-state/-authenticated-with-profile.md b/docs/api/mozilla.components.service.fxa/-account-state/-authenticated-with-profile.md new file mode 100644 index 00000000000..fc68c9c6fc7 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-account-state/-authenticated-with-profile.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccountState](index.md) / [AuthenticatedWithProfile](./-authenticated-with-profile.md) + +# AuthenticatedWithProfile + +`AuthenticatedWithProfile` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L28) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-account-state/-not-authenticated.md b/docs/api/mozilla.components.service.fxa/-account-state/-not-authenticated.md new file mode 100644 index 00000000000..475d5308413 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-account-state/-not-authenticated.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccountState](index.md) / [NotAuthenticated](./-not-authenticated.md) + +# NotAuthenticated + +`NotAuthenticated` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L26) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-account-state/-start.md b/docs/api/mozilla.components.service.fxa/-account-state/-start.md new file mode 100644 index 00000000000..3584f1801c6 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-account-state/-start.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccountState](index.md) / [Start](./-start.md) + +# Start + +`Start` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L25) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-account-state/index.md b/docs/api/mozilla.components.service.fxa/-account-state/index.md new file mode 100644 index 00000000000..a271687536f --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-account-state/index.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccountState](./index.md) + +# AccountState + +`enum class AccountState` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L24) + +### Enum Values + +| Name | Summary | +|---|---| +| [Start](-start.md) | | +| [NotAuthenticated](-not-authenticated.md) | | +| [AuthenticatedNoProfile](-authenticated-no-profile.md) | | +| [AuthenticatedWithProfile](-authenticated-with-profile.md) | | diff --git a/docs/api/mozilla.components.service.fxa/-account-storage/clear.md b/docs/api/mozilla.components.service.fxa/-account-storage/clear.md new file mode 100644 index 00000000000..3856c772561 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-account-storage/clear.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccountStorage](index.md) / [clear](./clear.md) + +# clear + +`abstract fun clear(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccountStorage.kt#L17) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-account-storage/index.md b/docs/api/mozilla.components.service.fxa/-account-storage/index.md new file mode 100644 index 00000000000..6ceaf743fb2 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-account-storage/index.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccountStorage](./index.md) + +# AccountStorage + +`interface AccountStorage` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccountStorage.kt#L13) + +### Functions + +| Name | Summary | +|---|---| +| [clear](clear.md) | `abstract fun clear(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [read](read.md) | `abstract fun read(): `[`FirefoxAccountShaped`](../-firefox-account-shaped/index.md)`?` | +| [write](write.md) | `abstract fun write(account: `[`FirefoxAccountShaped`](../-firefox-account-shaped/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [SharedPrefAccountStorage](../-shared-pref-account-storage/index.md) | `class SharedPrefAccountStorage : `[`AccountStorage`](./index.md) | diff --git a/docs/api/mozilla.components.service.fxa/-account-storage/read.md b/docs/api/mozilla.components.service.fxa/-account-storage/read.md new file mode 100644 index 00000000000..aaf1c88fee9 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-account-storage/read.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccountStorage](index.md) / [read](./read.md) + +# read + +`abstract fun read(): `[`FirefoxAccountShaped`](../-firefox-account-shaped/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccountStorage.kt#L15) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-account-storage/write.md b/docs/api/mozilla.components.service.fxa/-account-storage/write.md new file mode 100644 index 00000000000..0616361562f --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-account-storage/write.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [AccountStorage](index.md) / [write](./write.md) + +# write + +`abstract fun write(account: `[`FirefoxAccountShaped`](../-firefox-account-shaped/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccountStorage.kt#L16) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-avatar/-init-.md b/docs/api/mozilla.components.service.fxa/-avatar/-init-.md new file mode 100644 index 00000000000..f28d4a3b92e --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-avatar/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [Avatar](index.md) / [<init>](./-init-.md) + +# <init> + +`Avatar(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, isDefault: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-avatar/index.md b/docs/api/mozilla.components.service.fxa/-avatar/index.md new file mode 100644 index 00000000000..33b5e74379a --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-avatar/index.md @@ -0,0 +1,18 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [Avatar](./index.md) + +# Avatar + +`data class Avatar` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Profile.kt#L9) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Avatar(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, isDefault: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` | + +### Properties + +| Name | Summary | +|---|---| +| [isDefault](is-default.md) | `val isDefault: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [url](url.md) | `val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.service.fxa/-avatar/is-default.md b/docs/api/mozilla.components.service.fxa/-avatar/is-default.md new file mode 100644 index 00000000000..5094b97f2ef --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-avatar/is-default.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [Avatar](index.md) / [isDefault](./is-default.md) + +# isDefault + +`val isDefault: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Profile.kt#L11) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-avatar/url.md b/docs/api/mozilla.components.service.fxa/-avatar/url.md new file mode 100644 index 00000000000..5cdf3c6f1cf --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-avatar/url.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [Avatar](index.md) / [url](./url.md) + +# url + +`val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Profile.kt#L10) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-config.md b/docs/api/mozilla.components.service.fxa/-config.md new file mode 100644 index 00000000000..e44a604cab2 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-config.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.service.fxa](index.md) / [Config](./-config.md) + +# Config + +`typealias Config = Config` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Config.kt#L7) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-f-x-a_-s-t-a-t-e_-k-e-y.md b/docs/api/mozilla.components.service.fxa/-f-x-a_-s-t-a-t-e_-k-e-y.md new file mode 100644 index 00000000000..6728c836ee9 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-f-x-a_-s-t-a-t-e_-k-e-y.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.service.fxa](index.md) / [FXA_STATE_KEY](./-f-x-a_-s-t-a-t-e_-k-e-y.md) + +# FXA_STATE_KEY + +`const val FXA_STATE_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccountStorage.kt#L11) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-f-x-a_-s-t-a-t-e_-p-r-e-f-s_-k-e-y.md b/docs/api/mozilla.components.service.fxa/-f-x-a_-s-t-a-t-e_-p-r-e-f-s_-k-e-y.md new file mode 100644 index 00000000000..2c155aa6ed8 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-f-x-a_-s-t-a-t-e_-p-r-e-f-s_-k-e-y.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.service.fxa](index.md) / [FXA_STATE_PREFS_KEY](./-f-x-a_-s-t-a-t-e_-p-r-e-f-s_-k-e-y.md) + +# FXA_STATE_PREFS_KEY + +`const val FXA_STATE_PREFS_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccountStorage.kt#L10) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-failed-to-load-account-exception/-init-.md b/docs/api/mozilla.components.service.fxa/-failed-to-load-account-exception/-init-.md new file mode 100644 index 00000000000..a7d165f9636 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-failed-to-load-account-exception/-init-.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FailedToLoadAccountException](index.md) / [<init>](./-init-.md) + +# <init> + +`FailedToLoadAccountException(cause: `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)`?)` + +Propagated via [AccountObserver.onError](../-account-observer/on-error.md) if we fail to load a locally stored account during +initialization. No action is necessary from consumers. +Account state has been re-initialized. + +### Parameters + +`cause` - Optional original cause of failure. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-failed-to-load-account-exception/index.md b/docs/api/mozilla.components.service.fxa/-failed-to-load-account-exception/index.md new file mode 100644 index 00000000000..e0c78a96ab0 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-failed-to-load-account-exception/index.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FailedToLoadAccountException](./index.md) + +# FailedToLoadAccountException + +`class FailedToLoadAccountException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L70) + +Propagated via [AccountObserver.onError](../-account-observer/on-error.md) if we fail to load a locally stored account during +initialization. No action is necessary from consumers. +Account state has been re-initialized. + +### Parameters + +`cause` - Optional original cause of failure. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FailedToLoadAccountException(cause: `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)`?)`
Propagated via [AccountObserver.onError](../-account-observer/on-error.md) if we fail to load a locally stored account during initialization. No action is necessary from consumers. Account state has been re-initialized. | diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/begin-o-auth-flow.md b/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/begin-o-auth-flow.md new file mode 100644 index 00000000000..0012358d937 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/begin-o-auth-flow.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccountShaped](index.md) / [beginOAuthFlow](./begin-o-auth-flow.md) + +# beginOAuthFlow + +`abstract 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)`): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L20) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/begin-pairing-flow.md b/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/begin-pairing-flow.md new file mode 100644 index 00000000000..71a867261d6 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/begin-pairing-flow.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccountShaped](index.md) / [beginPairingFlow](./begin-pairing-flow.md) + +# beginPairingFlow + +`abstract fun beginPairingFlow(pairingUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, 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)`>): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L21) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/complete-o-auth-flow.md b/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/complete-o-auth-flow.md new file mode 100644 index 00000000000..a4efc29ea56 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/complete-o-auth-flow.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccountShaped](index.md) / [completeOAuthFlow](./complete-o-auth-flow.md) + +# completeOAuthFlow + +`abstract 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)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L24) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/get-access-token.md b/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/get-access-token.md new file mode 100644 index 00000000000..570958338d5 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/get-access-token.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccountShaped](index.md) / [getAccessToken](./get-access-token.md) + +# getAccessToken + +`abstract fun getAccessToken(singleScope: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`AccessTokenInfo`](../-access-token-info/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L25) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/get-profile.md b/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/get-profile.md new file mode 100644 index 00000000000..d78b7a06486 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/get-profile.md @@ -0,0 +1,6 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccountShaped](index.md) / [getProfile](./get-profile.md) + +# getProfile + +`abstract fun getProfile(ignoreCache: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): Deferred<`[`Profile`](../-profile/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L22) +`abstract fun getProfile(): Deferred<`[`Profile`](../-profile/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L23) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/get-token-server-endpoint-u-r-l.md b/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/get-token-server-endpoint-u-r-l.md new file mode 100644 index 00000000000..2a05e62a353 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/get-token-server-endpoint-u-r-l.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccountShaped](index.md) / [getTokenServerEndpointURL](./get-token-server-endpoint-u-r-l.md) + +# getTokenServerEndpointURL + +`abstract fun getTokenServerEndpointURL(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L26) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/index.md b/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/index.md new file mode 100644 index 00000000000..b8c42fe1fd3 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccountShaped](./index.md) + +# FirefoxAccountShaped + +`interface FirefoxAccountShaped : `[`AutoCloseable`](https://developer.android.com/reference/java/lang/AutoCloseable.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L19) + +Facilitates testing consumers of FirefoxAccount. + +### Functions + +| Name | Summary | +|---|---| +| [beginOAuthFlow](begin-o-auth-flow.md) | `abstract 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)`): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` | +| [beginPairingFlow](begin-pairing-flow.md) | `abstract fun beginPairingFlow(pairingUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, 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)`>): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` | +| [completeOAuthFlow](complete-o-auth-flow.md) | `abstract 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)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` | +| [getAccessToken](get-access-token.md) | `abstract fun getAccessToken(singleScope: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`AccessTokenInfo`](../-access-token-info/index.md)`>` | +| [getProfile](get-profile.md) | `abstract fun getProfile(ignoreCache: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): Deferred<`[`Profile`](../-profile/index.md)`>`
`abstract fun getProfile(): Deferred<`[`Profile`](../-profile/index.md)`>` | +| [getTokenServerEndpointURL](get-token-server-endpoint-u-r-l.md) | `abstract fun getTokenServerEndpointURL(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [toJSONString](to-j-s-o-n-string.md) | `abstract fun toJSONString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [FirefoxAccount](../-firefox-account/index.md) | `class FirefoxAccount : `[`FirefoxAccountShaped`](./index.md)
FirefoxAccount represents the authentication state of a client. | diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/to-j-s-o-n-string.md b/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/to-j-s-o-n-string.md new file mode 100644 index 00000000000..1a0adcd108c --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account-shaped/to-j-s-o-n-string.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccountShaped](index.md) / [toJSONString](./to-j-s-o-n-string.md) + +# toJSONString + +`abstract fun toJSONString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L27) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/-init-.md b/docs/api/mozilla.components.service.fxa/-firefox-account/-init-.md new file mode 100644 index 00000000000..9db6f2c6b8d --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/-init-.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccount](index.md) / [<init>](./-init-.md) + +# <init> + +`FirefoxAccount(config: `[`Config`](../-config.md)`)` + +Construct a FirefoxAccount from a [Config](../-config.md), a clientId, and a redirectUri. + +Note that it is not necessary to `close` the Config if this constructor is used (however +doing so will not cause an error). + diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/begin-o-auth-flow.md b/docs/api/mozilla.components.service.fxa/-firefox-account/begin-o-auth-flow.md new file mode 100644 index 00000000000..4d7d7376d55 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/begin-o-auth-flow.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccount](index.md) / [beginOAuthFlow](./begin-o-auth-flow.md) + +# 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)`): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L59) + +Overrides [FirefoxAccountShaped.beginOAuthFlow](../-firefox-account-shaped/begin-o-auth-flow.md) + +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** +Deferred that resolves to the flow URL when complete + diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/begin-pairing-flow.md b/docs/api/mozilla.components.service.fxa/-firefox-account/begin-pairing-flow.md new file mode 100644 index 00000000000..cd30f94c4c4 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/begin-pairing-flow.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccount](index.md) / [beginPairingFlow](./begin-pairing-flow.md) + +# beginPairingFlow + +`fun beginPairingFlow(pairingUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, 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)`>): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L63) + +Overrides [FirefoxAccountShaped.beginPairingFlow](../-firefox-account-shaped/begin-pairing-flow.md) + diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/close.md b/docs/api/mozilla.components.service.fxa/-firefox-account/close.md new file mode 100644 index 00000000000..e15192a30e4 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/close.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccount](index.md) / [close](./close.md) + +# close + +`fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L47) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/complete-o-auth-flow.md b/docs/api/mozilla.components.service.fxa/-firefox-account/complete-o-auth-flow.md new file mode 100644 index 00000000000..db216d10c97 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/complete-o-auth-flow.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccount](index.md) / [completeOAuthFlow](./complete-o-auth-flow.md) + +# 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)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L112) + +Overrides [FirefoxAccountShaped.completeOAuthFlow](../-firefox-account-shaped/complete-o-auth-flow.md) + +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.md). + +Modifies the FirefoxAccount state. + diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/from-j-s-o-n-string.md b/docs/api/mozilla.components.service.fxa/-firefox-account/from-j-s-o-n-string.md new file mode 100644 index 00000000000..b943714268c --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/from-j-s-o-n-string.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccount](index.md) / [fromJSONString](./from-j-s-o-n-string.md) + +# fromJSONString + +`fun fromJSONString(json: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`FirefoxAccount`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L147) + +Restores the account's authentication state from a JSON string produced by +[FirefoxAccount.toJSONString](to-j-s-o-n-string.md). + +**Return** +[FirefoxAccount](index.md) representing the authentication state + diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/get-access-token.md b/docs/api/mozilla.components.service.fxa/-firefox-account/get-access-token.md new file mode 100644 index 00000000000..2070cb1aedd --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/get-access-token.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccount](index.md) / [getAccessToken](./get-access-token.md) + +# getAccessToken + +`fun getAccessToken(singleScope: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`AccessTokenInfo`](../-access-token-info/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L125) + +Overrides [FirefoxAccountShaped.getAccessToken](../-firefox-account-shaped/get-access-token.md) + +Tries to fetch an access token for the given scope. + +### Parameters + +`scope` - Single OAuth scope (no spaces) for which the client wants access + +### Exceptions + +`Unauthorized` - We couldn't provide an access token for this scope. +The caller should then start the OAuth Flow again with the desired scope. + +**Return** +[AccessTokenInfo](../-access-token-info/index.md) that stores the token, along with its scope, key and + expiration timestamp (in seconds) since epoch when complete + diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/get-connection-success-u-r-l.md b/docs/api/mozilla.components.service.fxa/-firefox-account/get-connection-success-u-r-l.md new file mode 100644 index 00000000000..6680d4005d5 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/get-connection-success-u-r-l.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccount](index.md) / [getConnectionSuccessURL](./get-connection-success-u-r-l.md) + +# getConnectionSuccessURL + +`fun getConnectionSuccessURL(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L102) + +Fetches the connection success url. + diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/get-profile.md b/docs/api/mozilla.components.service.fxa/-firefox-account/get-profile.md new file mode 100644 index 00000000000..42cd027b8f8 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/get-profile.md @@ -0,0 +1,38 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccount](index.md) / [getProfile](./get-profile.md) + +# getProfile + +`fun getProfile(ignoreCache: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): Deferred<`[`Profile`](../-profile/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L76) + +Overrides [FirefoxAccountShaped.getProfile](../-firefox-account-shaped/get-profile.md) + +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 + +### Exceptions + +`Unauthorized` - We couldn't find any suitable access token to make that call. +The caller should then start the OAuth Flow again with the "profile" scope. + +**Return** +Deferred<[Profile](../-profile/index.md)> representing the user's basic profile info + +`fun getProfile(): Deferred<`[`Profile`](../-profile/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L90) + +Overrides [FirefoxAccountShaped.getProfile](../-firefox-account-shaped/get-profile.md) + +Convenience method to fetch the profile from a cached account by default, but fall back +to retrieval from the server. + +### Exceptions + +`Unauthorized` - We couldn't find any suitable access token to make that call. +The caller should then start the OAuth Flow again with the "profile" scope. + +**Return** +Deferred<[Profile](../-profile/index.md)> representing the user's basic profile info + diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/get-token-server-endpoint-u-r-l.md b/docs/api/mozilla.components.service.fxa/-firefox-account/get-token-server-endpoint-u-r-l.md new file mode 100644 index 00000000000..1a222c7d2f8 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/get-token-server-endpoint-u-r-l.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccount](index.md) / [getTokenServerEndpointURL](./get-token-server-endpoint-u-r-l.md) + +# getTokenServerEndpointURL + +`fun getTokenServerEndpointURL(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L95) + +Overrides [FirefoxAccountShaped.getTokenServerEndpointURL](../-firefox-account-shaped/get-token-server-endpoint-u-r-l.md) + +Fetches the token server endpoint, for authentication using the SAML bearer flow. + diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/index.md b/docs/api/mozilla.components.service.fxa/-firefox-account/index.md new file mode 100644 index 00000000000..0439d8e5189 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/index.md @@ -0,0 +1,33 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccount](./index.md) + +# FirefoxAccount + +`class FirefoxAccount : `[`FirefoxAccountShaped`](../-firefox-account-shaped/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L33) + +FirefoxAccount represents the authentication state of a client. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FirefoxAccount(config: `[`Config`](../-config.md)`)`
Construct a FirefoxAccount from a [Config](../-config.md), a clientId, and a redirectUri. | + +### Functions + +| Name | Summary | +|---|---| +| [beginOAuthFlow](begin-o-auth-flow.md) | `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)`): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>`
Constructs a URL used to begin the OAuth flow for the requested scopes and keys. | +| [beginPairingFlow](begin-pairing-flow.md) | `fun beginPairingFlow(pairingUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, 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)`>): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` | +| [close](close.md) | `fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [completeOAuthFlow](complete-o-auth-flow.md) | `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)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/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.md). | +| [getAccessToken](get-access-token.md) | `fun getAccessToken(singleScope: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`AccessTokenInfo`](../-access-token-info/index.md)`>`
Tries to fetch an access token for the given scope. | +| [getConnectionSuccessURL](get-connection-success-u-r-l.md) | `fun getConnectionSuccessURL(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Fetches the connection success url. | +| [getProfile](get-profile.md) | `fun getProfile(ignoreCache: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): Deferred<`[`Profile`](../-profile/index.md)`>`
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(): Deferred<`[`Profile`](../-profile/index.md)`>`
Convenience method to fetch the profile from a cached account by default, but fall back to retrieval from the server. | +| [getTokenServerEndpointURL](get-token-server-endpoint-u-r-l.md) | `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. | +| [toJSONString](to-j-s-o-n-string.md) | `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.md). | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [fromJSONString](from-j-s-o-n-string.md) | `fun fromJSONString(json: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/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.md). | diff --git a/docs/api/mozilla.components.service.fxa/-firefox-account/to-j-s-o-n-string.md b/docs/api/mozilla.components.service.fxa/-firefox-account/to-j-s-o-n-string.md new file mode 100644 index 00000000000..81c6bfabed1 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-firefox-account/to-j-s-o-n-string.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FirefoxAccount](index.md) / [toJSONString](./to-j-s-o-n-string.md) + +# toJSONString + +`fun toJSONString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FirefoxAccount.kt#L138) + +Overrides [FirefoxAccountShaped.toJSONString](../-firefox-account-shaped/to-j-s-o-n-string.md) + +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.md). + +**Return** +String containing the authentication details in JSON format + diff --git a/docs/api/mozilla.components.service.fxa/-fxa-account-manager/-init-.md b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/-init-.md new file mode 100644 index 00000000000..1eeb871acc5 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/-init-.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FxaAccountManager](index.md) / [<init>](./-init-.md) + +# <init> + +`FxaAccountManager(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, config: `[`Config`](../-config.md)`, 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)`>, accountStorage: `[`AccountStorage`](../-account-storage/index.md)` = SharedPrefAccountStorage(context))` + +An account manager which encapsulates various internal details of an account lifecycle and provides +an observer interface along with a public API for interacting with an account. +The internal state machine abstracts over state space as exposed by the fxaclient library, not +the internal states experienced by lower-level representation of a Firefox Account; those are opaque to us. + +Class is 'open' to facilitate testing. + +### Parameters + +`context` - A [Context](https://developer.android.com/reference/android/content/Context.html) instance that's used for internal messaging and interacting with local storage. + +`config` - A [Config](../-config.md) used for account initialization. + +`scopes` - A list of scopes which will be requested during account authentication. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-fxa-account-manager/account-profile.md b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/account-profile.md new file mode 100644 index 00000000000..d81cba08c61 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/account-profile.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FxaAccountManager](index.md) / [accountProfile](./account-profile.md) + +# accountProfile + +`fun accountProfile(): `[`Profile`](../-profile/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L215) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-fxa-account-manager/authenticated-account.md b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/authenticated-account.md new file mode 100644 index 00000000000..51d342c2a6c --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/authenticated-account.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FxaAccountManager](index.md) / [authenticatedAccount](./authenticated-account.md) + +# authenticatedAccount + +`fun authenticatedAccount(): `[`FirefoxAccountShaped`](../-firefox-account-shaped/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L207) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-fxa-account-manager/begin-authentication.md b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/begin-authentication.md new file mode 100644 index 00000000000..f8c4670ea68 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/begin-authentication.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FxaAccountManager](index.md) / [beginAuthentication](./begin-authentication.md) + +# beginAuthentication + +`fun beginAuthentication(): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L226) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-fxa-account-manager/close.md b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/close.md new file mode 100644 index 00000000000..94d526191e2 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/close.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FxaAccountManager](index.md) / [close](./close.md) + +# close + +`open fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L254) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-fxa-account-manager/create-account.md b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/create-account.md new file mode 100644 index 00000000000..8740dd8d1fa --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/create-account.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FxaAccountManager](index.md) / [createAccount](./create-account.md) + +# createAccount + +`open fun createAccount(config: `[`Config`](../-config.md)`): `[`FirefoxAccountShaped`](../-firefox-account-shaped/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L423) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-fxa-account-manager/finish-authentication.md b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/finish-authentication.md new file mode 100644 index 00000000000..efdd90d9946 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/finish-authentication.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FxaAccountManager](index.md) / [finishAuthentication](./finish-authentication.md) + +# finishAuthentication + +`fun finishAuthentication(code: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, state: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L246) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-fxa-account-manager/index.md b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/index.md new file mode 100644 index 00000000000..b5b1c241f9e --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/index.md @@ -0,0 +1,40 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FxaAccountManager](./index.md) + +# FxaAccountManager + +`open class FxaAccountManager : `[`Closeable`](https://developer.android.com/reference/java/io/Closeable.html)`, `[`Observable`](../../mozilla.components.support.base.observer/-observable/index.md)`<`[`AccountObserver`](../-account-observer/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L130) + +An account manager which encapsulates various internal details of an account lifecycle and provides +an observer interface along with a public API for interacting with an account. +The internal state machine abstracts over state space as exposed by the fxaclient library, not +the internal states experienced by lower-level representation of a Firefox Account; those are opaque to us. + +Class is 'open' to facilitate testing. + +### Parameters + +`context` - A [Context](https://developer.android.com/reference/android/content/Context.html) instance that's used for internal messaging and interacting with local storage. + +`config` - A [Config](../-config.md) used for account initialization. + +`scopes` - A list of scopes which will be requested during account authentication. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FxaAccountManager(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, config: `[`Config`](../-config.md)`, 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)`>, accountStorage: `[`AccountStorage`](../-account-storage/index.md)` = SharedPrefAccountStorage(context))`
An account manager which encapsulates various internal details of an account lifecycle and provides an observer interface along with a public API for interacting with an account. The internal state machine abstracts over state space as exposed by the fxaclient library, not the internal states experienced by lower-level representation of a Firefox Account; those are opaque to us. | + +### Functions + +| Name | Summary | +|---|---| +| [accountProfile](account-profile.md) | `fun accountProfile(): `[`Profile`](../-profile/index.md)`?` | +| [authenticatedAccount](authenticated-account.md) | `fun authenticatedAccount(): `[`FirefoxAccountShaped`](../-firefox-account-shaped/index.md)`?` | +| [beginAuthentication](begin-authentication.md) | `fun beginAuthentication(): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` | +| [close](close.md) | `open fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [createAccount](create-account.md) | `open fun createAccount(config: `[`Config`](../-config.md)`): `[`FirefoxAccountShaped`](../-firefox-account-shaped/index.md) | +| [finishAuthentication](finish-authentication.md) | `fun finishAuthentication(code: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, state: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` | +| [init](init.md) | `fun init(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Call this after registering your observers, and before interacting with this class. | +| [logout](logout.md) | `fun logout(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` | +| [updateProfile](update-profile.md) | `fun updateProfile(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` | diff --git a/docs/api/mozilla.components.service.fxa/-fxa-account-manager/init.md b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/init.md new file mode 100644 index 00000000000..6529cc686a8 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/init.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FxaAccountManager](index.md) / [init](./init.md) + +# init + +`fun init(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L203) + +Call this after registering your observers, and before interacting with this class. + diff --git a/docs/api/mozilla.components.service.fxa/-fxa-account-manager/logout.md b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/logout.md new file mode 100644 index 00000000000..a906c9488dc --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/logout.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FxaAccountManager](index.md) / [logout](./logout.md) + +# logout + +`fun logout(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L250) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-fxa-account-manager/update-profile.md b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/update-profile.md new file mode 100644 index 00000000000..673825d53d7 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-fxa-account-manager/update-profile.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [FxaAccountManager](index.md) / [updateProfile](./update-profile.md) + +# updateProfile + +`fun updateProfile(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaAccountManager.kt#L222) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-fxa-exception.md b/docs/api/mozilla.components.service.fxa/-fxa-exception.md new file mode 100644 index 00000000000..9ead98d890c --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-fxa-exception.md @@ -0,0 +1,8 @@ +[android-components](../index.md) / [mozilla.components.service.fxa](index.md) / [FxaException](./-fxa-exception.md) + +# FxaException + +`typealias FxaException = FxaException` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaException.kt#L10) + +High-level exception class for the exceptions thrown in the Rust library. + diff --git a/docs/api/mozilla.components.service.fxa/-fxa-network-exception.md b/docs/api/mozilla.components.service.fxa/-fxa-network-exception.md new file mode 100644 index 00000000000..ed505a0abc0 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-fxa-network-exception.md @@ -0,0 +1,8 @@ +[android-components](../index.md) / [mozilla.components.service.fxa](index.md) / [FxaNetworkException](./-fxa-network-exception.md) + +# FxaNetworkException + +`typealias FxaNetworkException = Network` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaException.kt#L15) + +Thrown on a network error. + diff --git a/docs/api/mozilla.components.service.fxa/-fxa-panic-exception.md b/docs/api/mozilla.components.service.fxa/-fxa-panic-exception.md new file mode 100644 index 00000000000..18796ae116a --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-fxa-panic-exception.md @@ -0,0 +1,8 @@ +[android-components](../index.md) / [mozilla.components.service.fxa](index.md) / [FxaPanicException](./-fxa-panic-exception.md) + +# FxaPanicException + +`typealias FxaPanicException = Panic` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaException.kt#L20) + +Thrown when the Rust library hits an assertion or panic (this is always a bug). + diff --git a/docs/api/mozilla.components.service.fxa/-fxa-unauthorized-exception.md b/docs/api/mozilla.components.service.fxa/-fxa-unauthorized-exception.md new file mode 100644 index 00000000000..f9fd316929b --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-fxa-unauthorized-exception.md @@ -0,0 +1,8 @@ +[android-components](../index.md) / [mozilla.components.service.fxa](index.md) / [FxaUnauthorizedException](./-fxa-unauthorized-exception.md) + +# FxaUnauthorizedException + +`typealias FxaUnauthorizedException = Unauthorized` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaException.kt#L25) + +Thrown when the operation requires additional authorization. + diff --git a/docs/api/mozilla.components.service.fxa/-fxa-unspecified-exception.md b/docs/api/mozilla.components.service.fxa/-fxa-unspecified-exception.md new file mode 100644 index 00000000000..0ac076285f0 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-fxa-unspecified-exception.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.service.fxa](index.md) / [FxaUnspecifiedException](./-fxa-unspecified-exception.md) + +# FxaUnspecifiedException + +`typealias FxaUnspecifiedException = Unspecified` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/FxaException.kt#L31) + +Thrown when the Rust library hits an unexpected error that isn't a panic. +This may indicate library misuse, network errors, etc. + diff --git a/docs/api/mozilla.components.service.fxa/-o-auth-scoped-key/-init-.md b/docs/api/mozilla.components.service.fxa/-o-auth-scoped-key/-init-.md new file mode 100644 index 00000000000..06638f065d1 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-o-auth-scoped-key/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [OAuthScopedKey](index.md) / [<init>](./-init-.md) + +# <init> + +`OAuthScopedKey(kid: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, k: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` + +Scoped key data. + diff --git a/docs/api/mozilla.components.service.fxa/-o-auth-scoped-key/index.md b/docs/api/mozilla.components.service.fxa/-o-auth-scoped-key/index.md new file mode 100644 index 00000000000..80f629717c5 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-o-auth-scoped-key/index.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [OAuthScopedKey](./index.md) + +# OAuthScopedKey + +`data class OAuthScopedKey` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccessTokenInfo.kt#L16) + +Scoped key data. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `OAuthScopedKey(kid: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, k: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)`
Scoped key data. | + +### Properties + +| Name | Summary | +|---|---| +| [k](k.md) | `val k: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The JWK key data. | +| [kid](kid.md) | `val kid: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The JWK key identifier. | diff --git a/docs/api/mozilla.components.service.fxa/-o-auth-scoped-key/k.md b/docs/api/mozilla.components.service.fxa/-o-auth-scoped-key/k.md new file mode 100644 index 00000000000..e179a0b628b --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-o-auth-scoped-key/k.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [OAuthScopedKey](index.md) / [k](./k.md) + +# k + +`val k: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccessTokenInfo.kt#L18) + +The JWK key data. + +### Property + +`k` - The JWK key data. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-o-auth-scoped-key/kid.md b/docs/api/mozilla.components.service.fxa/-o-auth-scoped-key/kid.md new file mode 100644 index 00000000000..ac174f05b91 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-o-auth-scoped-key/kid.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [OAuthScopedKey](index.md) / [kid](./kid.md) + +# kid + +`val kid: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccessTokenInfo.kt#L17) + +The JWK key identifier. + +### Property + +`kid` - The JWK key identifier. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-profile/-init-.md b/docs/api/mozilla.components.service.fxa/-profile/-init-.md new file mode 100644 index 00000000000..2a741c220b1 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-profile/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [Profile](index.md) / [<init>](./-init-.md) + +# <init> + +`Profile(uid: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, email: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, avatar: `[`Avatar`](../-avatar/index.md)`?, displayName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?)` \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-profile/avatar.md b/docs/api/mozilla.components.service.fxa/-profile/avatar.md new file mode 100644 index 00000000000..9c989276392 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-profile/avatar.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [Profile](index.md) / [avatar](./avatar.md) + +# avatar + +`val avatar: `[`Avatar`](../-avatar/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Profile.kt#L17) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-profile/display-name.md b/docs/api/mozilla.components.service.fxa/-profile/display-name.md new file mode 100644 index 00000000000..e2c20589f94 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-profile/display-name.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [Profile](index.md) / [displayName](./display-name.md) + +# displayName + +`val displayName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Profile.kt#L18) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-profile/email.md b/docs/api/mozilla.components.service.fxa/-profile/email.md new file mode 100644 index 00000000000..0fe7f7bdc6f --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-profile/email.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [Profile](index.md) / [email](./email.md) + +# email + +`val email: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Profile.kt#L16) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-profile/index.md b/docs/api/mozilla.components.service.fxa/-profile/index.md new file mode 100644 index 00000000000..3fbc4913162 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-profile/index.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [Profile](./index.md) + +# Profile + +`data class Profile` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Profile.kt#L14) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Profile(uid: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, email: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?, avatar: `[`Avatar`](../-avatar/index.md)`?, displayName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?)` | + +### Properties + +| Name | Summary | +|---|---| +| [avatar](avatar.md) | `val avatar: `[`Avatar`](../-avatar/index.md)`?` | +| [displayName](display-name.md) | `val displayName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [email](email.md) | `val email: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [uid](uid.md) | `val uid: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | diff --git a/docs/api/mozilla.components.service.fxa/-profile/uid.md b/docs/api/mozilla.components.service.fxa/-profile/uid.md new file mode 100644 index 00000000000..74b80886e65 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-profile/uid.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [Profile](index.md) / [uid](./uid.md) + +# uid + +`val uid: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/Profile.kt#L15) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/-init-.md b/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/-init-.md new file mode 100644 index 00000000000..e4ffb7f99de --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [SharedPrefAccountStorage](index.md) / [<init>](./-init-.md) + +# <init> + +`SharedPrefAccountStorage(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`)` \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/clear.md b/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/clear.md new file mode 100644 index 00000000000..379bc2a379b --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/clear.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [SharedPrefAccountStorage](index.md) / [clear](./clear.md) + +# clear + +`fun clear(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccountStorage.kt#L39) + +Overrides [AccountStorage.clear](../-account-storage/clear.md) + diff --git a/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/context.md b/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/context.md new file mode 100644 index 00000000000..4ef6790be7d --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/context.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [SharedPrefAccountStorage](index.md) / [context](./context.md) + +# context + +`val context: `[`Context`](https://developer.android.com/reference/android/content/Context.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccountStorage.kt#L20) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/index.md b/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/index.md new file mode 100644 index 00000000000..68734bd01ea --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [SharedPrefAccountStorage](./index.md) + +# SharedPrefAccountStorage + +`class SharedPrefAccountStorage : `[`AccountStorage`](../-account-storage/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccountStorage.kt#L20) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SharedPrefAccountStorage(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`)` | + +### Properties + +| Name | Summary | +|---|---| +| [context](context.md) | `val context: `[`Context`](https://developer.android.com/reference/android/content/Context.html) | + +### Functions + +| Name | Summary | +|---|---| +| [clear](clear.md) | `fun clear(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [read](read.md) | `fun read(): `[`FirefoxAccountShaped`](../-firefox-account-shaped/index.md)`?` | +| [write](write.md) | `fun write(account: `[`FirefoxAccountShaped`](../-firefox-account-shaped/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/read.md b/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/read.md new file mode 100644 index 00000000000..a9ede3a91a0 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/read.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [SharedPrefAccountStorage](index.md) / [read](./read.md) + +# read + +`fun read(): `[`FirefoxAccountShaped`](../-firefox-account-shaped/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccountStorage.kt#L24) + +Overrides [AccountStorage.read](../-account-storage/read.md) + +### Exceptions + +`FxaException` - if JSON failed to parse into a [FirefoxAccount](../-firefox-account/index.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/write.md b/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/write.md new file mode 100644 index 00000000000..1b48591d431 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/-shared-pref-account-storage/write.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.fxa](../index.md) / [SharedPrefAccountStorage](index.md) / [write](./write.md) + +# write + +`fun write(account: `[`FirefoxAccountShaped`](../-firefox-account-shaped/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/AccountStorage.kt#L32) + +Overrides [AccountStorage.write](../-account-storage/write.md) + diff --git a/docs/api/mozilla.components.service.fxa/index.md b/docs/api/mozilla.components.service.fxa/index.md new file mode 100644 index 00000000000..19c5519d604 --- /dev/null +++ b/docs/api/mozilla.components.service.fxa/index.md @@ -0,0 +1,43 @@ +[android-components](../index.md) / [mozilla.components.service.fxa](./index.md) + +## Package mozilla.components.service.fxa + +### Types + +| Name | Summary | +|---|---| +| [AccessTokenInfo](-access-token-info/index.md) | `data class AccessTokenInfo`
The result of authentication with FxA via an OAuth flow. | +| [AccountObserver](-account-observer/index.md) | `interface AccountObserver`
Observer interface which lets its users monitor account state changes and major events. | +| [AccountState](-account-state/index.md) | `enum class AccountState` | +| [AccountStorage](-account-storage/index.md) | `interface AccountStorage` | +| [Avatar](-avatar/index.md) | `data class Avatar` | +| [FirefoxAccount](-firefox-account/index.md) | `class FirefoxAccount : `[`FirefoxAccountShaped`](-firefox-account-shaped/index.md)
FirefoxAccount represents the authentication state of a client. | +| [FirefoxAccountShaped](-firefox-account-shaped/index.md) | `interface FirefoxAccountShaped : `[`AutoCloseable`](https://developer.android.com/reference/java/lang/AutoCloseable.html)
Facilitates testing consumers of FirefoxAccount. | +| [FxaAccountManager](-fxa-account-manager/index.md) | `open class FxaAccountManager : `[`Closeable`](https://developer.android.com/reference/java/io/Closeable.html)`, `[`Observable`](../mozilla.components.support.base.observer/-observable/index.md)`<`[`AccountObserver`](-account-observer/index.md)`>`
An account manager which encapsulates various internal details of an account lifecycle and provides an observer interface along with a public API for interacting with an account. The internal state machine abstracts over state space as exposed by the fxaclient library, not the internal states experienced by lower-level representation of a Firefox Account; those are opaque to us. | +| [OAuthScopedKey](-o-auth-scoped-key/index.md) | `data class OAuthScopedKey`
Scoped key data. | +| [Profile](-profile/index.md) | `data class Profile` | +| [SharedPrefAccountStorage](-shared-pref-account-storage/index.md) | `class SharedPrefAccountStorage : `[`AccountStorage`](-account-storage/index.md) | + +### Exceptions + +| Name | Summary | +|---|---| +| [FailedToLoadAccountException](-failed-to-load-account-exception/index.md) | `class FailedToLoadAccountException : `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)
Propagated via [AccountObserver.onError](-account-observer/on-error.md) if we fail to load a locally stored account during initialization. No action is necessary from consumers. Account state has been re-initialized. | + +### Type Aliases + +| Name | Summary | +|---|---| +| [Config](-config.md) | `typealias Config = Config` | +| [FxaException](-fxa-exception.md) | `typealias FxaException = FxaException`
High-level exception class for the exceptions thrown in the Rust library. | +| [FxaNetworkException](-fxa-network-exception.md) | `typealias FxaNetworkException = Network`
Thrown on a network error. | +| [FxaPanicException](-fxa-panic-exception.md) | `typealias FxaPanicException = Panic`
Thrown when the Rust library hits an assertion or panic (this is always a bug). | +| [FxaUnauthorizedException](-fxa-unauthorized-exception.md) | `typealias FxaUnauthorizedException = Unauthorized`
Thrown when the operation requires additional authorization. | +| [FxaUnspecifiedException](-fxa-unspecified-exception.md) | `typealias FxaUnspecifiedException = Unspecified`
Thrown when the Rust library hits an unexpected error that isn't a panic. This may indicate library misuse, network errors, etc. | + +### Properties + +| Name | Summary | +|---|---| +| [FXA_STATE_KEY](-f-x-a_-s-t-a-t-e_-k-e-y.md) | `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.md) | `const val FXA_STATE_PREFS_KEY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.service.glean.config/-configuration/-init-.md b/docs/api/mozilla.components.service.glean.config/-configuration/-init-.md new file mode 100644 index 00000000000..578d699c204 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.config/-configuration/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.config](../index.md) / [Configuration](index.md) / [<init>](./-init-.md) + +# <init> + +`Configuration(serverEndpoint: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "https://incoming.telemetry.mozilla.org", userAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "Glean/${BuildConfig.LIBRARY_VERSION} (Android)", connectionTimeout: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 10000, readTimeout: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 30000, maxEvents: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 500, logPings: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false)` + +The Configuration class describes how to configure the Glean. + diff --git a/docs/api/mozilla.components.service.glean.config/-configuration/connection-timeout.md b/docs/api/mozilla.components.service.glean.config/-configuration/connection-timeout.md new file mode 100644 index 00000000000..3f42335ae37 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.config/-configuration/connection-timeout.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.config](../index.md) / [Configuration](index.md) / [connectionTimeout](./connection-timeout.md) + +# connectionTimeout + +`val connectionTimeout: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/config/Configuration.kt#L24) + +the timeout, in milliseconds, to use when connecting to + the [serverEndpoint](server-endpoint.md) + +### Property + +`connectionTimeout` - the timeout, in milliseconds, to use when connecting to + the [serverEndpoint](server-endpoint.md) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.config/-configuration/index.md b/docs/api/mozilla.components.service.glean.config/-configuration/index.md new file mode 100644 index 00000000000..98c4a5f5315 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.config/-configuration/index.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.config](../index.md) / [Configuration](./index.md) + +# Configuration + +`data class Configuration` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/config/Configuration.kt#L21) + +The Configuration class describes how to configure the Glean. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Configuration(serverEndpoint: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "https://incoming.telemetry.mozilla.org", userAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "Glean/${BuildConfig.LIBRARY_VERSION} (Android)", connectionTimeout: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 10000, readTimeout: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 30000, maxEvents: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 500, logPings: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false)`
The Configuration class describes how to configure the Glean. | + +### Properties + +| Name | Summary | +|---|---| +| [connectionTimeout](connection-timeout.md) | `val connectionTimeout: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
the timeout, in milliseconds, to use when connecting to the [serverEndpoint](server-endpoint.md) | +| [logPings](log-pings.md) | `val logPings: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
whether to log ping contents to the console. | +| [maxEvents](max-events.md) | `val maxEvents: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
the number of events to store before the events ping is sent | +| [readTimeout](read-timeout.md) | `val readTimeout: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
the timeout, in milliseconds, to use when connecting to the [serverEndpoint](server-endpoint.md) | +| [serverEndpoint](server-endpoint.md) | `val serverEndpoint: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
the server pings are sent to | +| [userAgent](user-agent.md) | `val userAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
the user agent used when sending pings | diff --git a/docs/api/mozilla.components.service.glean.config/-configuration/log-pings.md b/docs/api/mozilla.components.service.glean.config/-configuration/log-pings.md new file mode 100644 index 00000000000..ab66e6662cf --- /dev/null +++ b/docs/api/mozilla.components.service.glean.config/-configuration/log-pings.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.config](../index.md) / [Configuration](index.md) / [logPings](./log-pings.md) + +# logPings + +`val logPings: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/config/Configuration.kt#L27) + +whether to log ping contents to the console. + +### Property + +`logPings` - whether to log ping contents to the console. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.config/-configuration/max-events.md b/docs/api/mozilla.components.service.glean.config/-configuration/max-events.md new file mode 100644 index 00000000000..2d868c7c2bd --- /dev/null +++ b/docs/api/mozilla.components.service.glean.config/-configuration/max-events.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.config](../index.md) / [Configuration](index.md) / [maxEvents](./max-events.md) + +# maxEvents + +`val maxEvents: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/config/Configuration.kt#L26) + +the number of events to store before the events ping is sent + +### Property + +`maxEvents` - the number of events to store before the events ping is sent \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.config/-configuration/read-timeout.md b/docs/api/mozilla.components.service.glean.config/-configuration/read-timeout.md new file mode 100644 index 00000000000..3e706aa52ad --- /dev/null +++ b/docs/api/mozilla.components.service.glean.config/-configuration/read-timeout.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.config](../index.md) / [Configuration](index.md) / [readTimeout](./read-timeout.md) + +# readTimeout + +`val readTimeout: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/config/Configuration.kt#L25) + +the timeout, in milliseconds, to use when connecting to + the [serverEndpoint](server-endpoint.md) + +### Property + +`readTimeout` - the timeout, in milliseconds, to use when connecting to + the [serverEndpoint](server-endpoint.md) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.config/-configuration/server-endpoint.md b/docs/api/mozilla.components.service.glean.config/-configuration/server-endpoint.md new file mode 100644 index 00000000000..2779a00a1d8 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.config/-configuration/server-endpoint.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.config](../index.md) / [Configuration](index.md) / [serverEndpoint](./server-endpoint.md) + +# serverEndpoint + +`val serverEndpoint: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/config/Configuration.kt#L22) + +the server pings are sent to + +### Property + +`serverEndpoint` - the server pings are sent to \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.config/-configuration/user-agent.md b/docs/api/mozilla.components.service.glean.config/-configuration/user-agent.md new file mode 100644 index 00000000000..67729bd1041 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.config/-configuration/user-agent.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.config](../index.md) / [Configuration](index.md) / [userAgent](./user-agent.md) + +# userAgent + +`val userAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/config/Configuration.kt#L23) + +the user agent used when sending pings + +### Property + +`userAgent` - the user agent used when sending pings \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.config/index.md b/docs/api/mozilla.components.service.glean.config/index.md new file mode 100644 index 00000000000..54cc2f0191a --- /dev/null +++ b/docs/api/mozilla.components.service.glean.config/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.service.glean.config](./index.md) + +## Package mozilla.components.service.glean.config + +### Types + +| Name | Summary | +|---|---| +| [Configuration](-configuration/index.md) | `data class Configuration`
The Configuration class describes how to configure the Glean. | diff --git a/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/-init-.md b/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/-init-.md new file mode 100644 index 00000000000..edd0c01db38 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [RecordedEventData](index.md) / [<init>](./-init-.md) + +# <init> + +`RecordedEventData(category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, objectId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, msSinceStart: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, extra: `[`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, identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = if (category.isEmpty()) { name } else { "$category.$name" })` \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/category.md b/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/category.md new file mode 100644 index 00000000000..f364c1afb9b --- /dev/null +++ b/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/category.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [RecordedEventData](index.md) / [category](./category.md) + +# category + +`val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/EventsStorageEngine.kt#L126) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/extra.md b/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/extra.md new file mode 100644 index 00000000000..6ca098e8080 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/extra.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [RecordedEventData](index.md) / [extra](./extra.md) + +# extra + +`val extra: `[`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)`>?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/EventsStorageEngine.kt#L131) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/index.md b/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/index.md new file mode 100644 index 00000000000..9980b2c5157 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/index.md @@ -0,0 +1,22 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [RecordedEventData](./index.md) + +# RecordedEventData + +`data class RecordedEventData` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/EventsStorageEngine.kt#L125) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `RecordedEventData(category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, objectId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, msSinceStart: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, extra: `[`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, identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = if (category.isEmpty()) { name } else { "$category.$name" })` | + +### Properties + +| Name | Summary | +|---|---| +| [category](category.md) | `val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [extra](extra.md) | `val extra: `[`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)`>?` | +| [msSinceStart](ms-since-start.md) | `val msSinceStart: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | +| [name](name.md) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [objectId](object-id.md) | `val objectId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [value](value.md) | `val value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | diff --git a/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/ms-since-start.md b/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/ms-since-start.md new file mode 100644 index 00000000000..71f8f4e3d7e --- /dev/null +++ b/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/ms-since-start.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [RecordedEventData](index.md) / [msSinceStart](./ms-since-start.md) + +# msSinceStart + +`val msSinceStart: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/EventsStorageEngine.kt#L129) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/name.md b/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/name.md new file mode 100644 index 00000000000..ecc8cc71e69 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/name.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [RecordedEventData](index.md) / [name](./name.md) + +# name + +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/EventsStorageEngine.kt#L127) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/object-id.md b/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/object-id.md new file mode 100644 index 00000000000..f86f227553a --- /dev/null +++ b/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/object-id.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [RecordedEventData](index.md) / [objectId](./object-id.md) + +# objectId + +`val objectId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/EventsStorageEngine.kt#L128) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/value.md b/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/value.md new file mode 100644 index 00000000000..6807f4a33b9 --- /dev/null +++ b/docs/api/mozilla.components.service.glean.storages/-recorded-event-data/value.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean.storages](../index.md) / [RecordedEventData](index.md) / [value](./value.md) + +# value + +`val value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/storages/EventsStorageEngine.kt#L130) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean.storages/index.md b/docs/api/mozilla.components.service.glean.storages/index.md new file mode 100644 index 00000000000..6b6e287a6fa --- /dev/null +++ b/docs/api/mozilla.components.service.glean.storages/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.service.glean.storages](./index.md) + +## Package mozilla.components.service.glean.storages + +### Types + +| Name | Summary | +|---|---| +| [RecordedEventData](-recorded-event-data/index.md) | `data class RecordedEventData` | diff --git a/docs/api/mozilla.components.service.glean/-boolean-metric-type/-init-.md b/docs/api/mozilla.components.service.glean/-boolean-metric-type/-init-.md new file mode 100644 index 00000000000..9494887722c --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-boolean-metric-type/-init-.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [BooleanMetricType](index.md) / [<init>](./-init-.md) + +# <init> + +`BooleanMetricType(disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, lifetime: `[`Lifetime`](../-lifetime/index.md)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>)` + +This implements the developer facing API for recording boolean metrics. + +Instances of this class type are automatically generated by the parsers at build time, +allowing developers to record values that were previously registered in the metrics.yaml file. + +The boolean API only exposes the [set](set.md) method. + diff --git a/docs/api/mozilla.components.service.glean/-boolean-metric-type/category.md b/docs/api/mozilla.components.service.glean/-boolean-metric-type/category.md new file mode 100644 index 00000000000..3459d7e5cbe --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-boolean-metric-type/category.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [BooleanMetricType](index.md) / [category](./category.md) + +# category + +`val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/BooleanMetricType.kt#L22) + +Overrides [CommonMetricData.category](../-common-metric-data/category.md) + diff --git a/docs/api/mozilla.components.service.glean/-boolean-metric-type/default-storage-destinations.md b/docs/api/mozilla.components.service.glean/-boolean-metric-type/default-storage-destinations.md new file mode 100644 index 00000000000..457d94cbd7d --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-boolean-metric-type/default-storage-destinations.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [BooleanMetricType](index.md) / [defaultStorageDestinations](./default-storage-destinations.md) + +# defaultStorageDestinations + +`val defaultStorageDestinations: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/BooleanMetricType.kt#L28) + +Overrides [CommonMetricData.defaultStorageDestinations](../-common-metric-data/default-storage-destinations.md) + +Defines the names of the storages the metric defaults to when +"default" is used as the destination storage. +Note that every metric type will need to override this. + diff --git a/docs/api/mozilla.components.service.glean/-boolean-metric-type/disabled.md b/docs/api/mozilla.components.service.glean/-boolean-metric-type/disabled.md new file mode 100644 index 00000000000..84cdc65fc72 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-boolean-metric-type/disabled.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [BooleanMetricType](index.md) / [disabled](./disabled.md) + +# disabled + +`val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/BooleanMetricType.kt#L21) + +Overrides [CommonMetricData.disabled](../-common-metric-data/disabled.md) + diff --git a/docs/api/mozilla.components.service.glean/-boolean-metric-type/index.md b/docs/api/mozilla.components.service.glean/-boolean-metric-type/index.md new file mode 100644 index 00000000000..2bb28caee60 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-boolean-metric-type/index.md @@ -0,0 +1,50 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [BooleanMetricType](./index.md) + +# BooleanMetricType + +`data class BooleanMetricType : `[`CommonMetricData`](../-common-metric-data/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/BooleanMetricType.kt#L20) + +This implements the developer facing API for recording boolean metrics. + +Instances of this class type are automatically generated by the parsers at build time, +allowing developers to record values that were previously registered in the metrics.yaml file. + +The boolean API only exposes the [set](set.md) method. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `BooleanMetricType(disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, lifetime: `[`Lifetime`](../-lifetime/index.md)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>)`
This implements the developer facing API for recording boolean metrics. | + +### Properties + +| Name | Summary | +|---|---| +| [category](category.md) | `val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [defaultStorageDestinations](default-storage-destinations.md) | `val defaultStorageDestinations: `[`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)`>`
Defines the names of the storages the metric defaults to when "default" is used as the destination storage. Note that every metric type will need to override this. | +| [disabled](disabled.md) | `val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [lifetime](lifetime.md) | `val lifetime: `[`Lifetime`](../-lifetime/index.md) | +| [name](name.md) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [sendInPings](send-in-pings.md) | `val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [identifier](../-common-metric-data/identifier.md) | `open val identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [set](set.md) | `fun set(value: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Set a boolean value. | +| [testGetValue](test-get-value.md) | `fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns the stored value for testing purposes only | +| [testHasValue](test-has-value.md) | `fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Tests whether a value is stored for the metric for testing purposes only | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getStorageNames](../-common-metric-data/get-storage-names.md) | `open fun getStorageNames(): `[`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)`>`
Get the list of storage names the metric will record to. This automatically expands [DEFAULT_STORAGE_NAME](#) to the list of default storages for the metric. | +| [shouldRecord](../-common-metric-data/should-record.md) | `open fun shouldRecord(logger: `[`Logger`](../../mozilla.components.support.base.log.logger/-logger/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | diff --git a/docs/api/mozilla.components.service.glean/-boolean-metric-type/lifetime.md b/docs/api/mozilla.components.service.glean/-boolean-metric-type/lifetime.md new file mode 100644 index 00000000000..97ab8efb738 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-boolean-metric-type/lifetime.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [BooleanMetricType](index.md) / [lifetime](./lifetime.md) + +# lifetime + +`val lifetime: `[`Lifetime`](../-lifetime/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/BooleanMetricType.kt#L23) + +Overrides [CommonMetricData.lifetime](../-common-metric-data/lifetime.md) + diff --git a/docs/api/mozilla.components.service.glean/-boolean-metric-type/name.md b/docs/api/mozilla.components.service.glean/-boolean-metric-type/name.md new file mode 100644 index 00000000000..28f765365ba --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-boolean-metric-type/name.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [BooleanMetricType](index.md) / [name](./name.md) + +# name + +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/BooleanMetricType.kt#L24) + +Overrides [CommonMetricData.name](../-common-metric-data/name.md) + diff --git a/docs/api/mozilla.components.service.glean/-boolean-metric-type/send-in-pings.md b/docs/api/mozilla.components.service.glean/-boolean-metric-type/send-in-pings.md new file mode 100644 index 00000000000..2572b40f2de --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-boolean-metric-type/send-in-pings.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [BooleanMetricType](index.md) / [sendInPings](./send-in-pings.md) + +# sendInPings + +`val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/BooleanMetricType.kt#L25) + +Overrides [CommonMetricData.sendInPings](../-common-metric-data/send-in-pings.md) + diff --git a/docs/api/mozilla.components.service.glean/-boolean-metric-type/set.md b/docs/api/mozilla.components.service.glean/-boolean-metric-type/set.md new file mode 100644 index 00000000000..7d432aae0f4 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-boolean-metric-type/set.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [BooleanMetricType](index.md) / [set](./set.md) + +# set + +`fun set(value: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/BooleanMetricType.kt#L37) + +Set a boolean value. + +### Parameters + +`value` - This is a user defined boolean value. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-boolean-metric-type/test-get-value.md b/docs/api/mozilla.components.service.glean/-boolean-metric-type/test-get-value.md new file mode 100644 index 00000000000..b17bf18dcee --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-boolean-metric-type/test-get-value.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [BooleanMetricType](index.md) / [testGetValue](./test-get-value.md) + +# testGetValue + +`fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/BooleanMetricType.kt#L76) + +Returns the stored value for testing purposes only + +### Parameters + +`pingName` - represents the name of the ping to retrieve the metric for. Defaults + to the either the first value in [defaultStorageDestinations](default-storage-destinations.md) or the first + value in [sendInPings](send-in-pings.md) + +### Exceptions + +`NullPointerException` - if no value is stored + +**Return** +value of the stored metric + diff --git a/docs/api/mozilla.components.service.glean/-boolean-metric-type/test-has-value.md b/docs/api/mozilla.components.service.glean/-boolean-metric-type/test-has-value.md new file mode 100644 index 00000000000..be0f2cb17fa --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-boolean-metric-type/test-has-value.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [BooleanMetricType](index.md) / [testHasValue](./test-has-value.md) + +# testHasValue + +`fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/BooleanMetricType.kt#L62) + +Tests whether a value is stored for the metric for testing purposes only + +### Parameters + +`pingName` - represents the name of the ping to retrieve the metric for. Defaults + to the either the first value in [defaultStorageDestinations](default-storage-destinations.md) or the first + value in [sendInPings](send-in-pings.md) + +**Return** +true if metric value exists, otherwise false + diff --git a/docs/api/mozilla.components.service.glean/-common-metric-data/category.md b/docs/api/mozilla.components.service.glean/-common-metric-data/category.md new file mode 100644 index 00000000000..f15b2cf3cda --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-common-metric-data/category.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CommonMetricData](index.md) / [category](./category.md) + +# category + +`abstract val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CommonMetricData.kt#L33) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-common-metric-data/default-storage-destinations.md b/docs/api/mozilla.components.service.glean/-common-metric-data/default-storage-destinations.md new file mode 100644 index 00000000000..1d2b2ea0f66 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-common-metric-data/default-storage-destinations.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CommonMetricData](index.md) / [defaultStorageDestinations](./default-storage-destinations.md) + +# defaultStorageDestinations + +`abstract val defaultStorageDestinations: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CommonMetricData.kt#L64) + +Defines the names of the storages the metric defaults to when +"default" is used as the destination storage. +Note that every metric type will need to override this. + diff --git a/docs/api/mozilla.components.service.glean/-common-metric-data/disabled.md b/docs/api/mozilla.components.service.glean/-common-metric-data/disabled.md new file mode 100644 index 00000000000..698cf842bcf --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-common-metric-data/disabled.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CommonMetricData](index.md) / [disabled](./disabled.md) + +# disabled + +`abstract val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CommonMetricData.kt#L32) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-common-metric-data/get-storage-names.md b/docs/api/mozilla.components.service.glean/-common-metric-data/get-storage-names.md new file mode 100644 index 00000000000..22f70bb4ba0 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-common-metric-data/get-storage-names.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CommonMetricData](index.md) / [getStorageNames](./get-storage-names.md) + +# getStorageNames + +`open fun getStorageNames(): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CommonMetricData.kt#L71) + +Get the list of storage names the metric will record to. This +automatically expands [DEFAULT_STORAGE_NAME](#) to the list of default +storages for the metric. + diff --git a/docs/api/mozilla.components.service.glean/-common-metric-data/identifier.md b/docs/api/mozilla.components.service.glean/-common-metric-data/identifier.md new file mode 100644 index 00000000000..1b8522f8eb6 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-common-metric-data/identifier.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CommonMetricData](index.md) / [identifier](./identifier.md) + +# identifier + +`open val identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CommonMetricData.kt#L38) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-common-metric-data/index.md b/docs/api/mozilla.components.service.glean/-common-metric-data/index.md new file mode 100644 index 00000000000..ef2a579e1ff --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-common-metric-data/index.md @@ -0,0 +1,39 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CommonMetricData](./index.md) + +# CommonMetricData + +`interface CommonMetricData` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CommonMetricData.kt#L31) + +This defines the common set of data shared across all the different +metric types. + +### Properties + +| Name | Summary | +|---|---| +| [category](category.md) | `abstract val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [defaultStorageDestinations](default-storage-destinations.md) | `abstract val defaultStorageDestinations: `[`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)`>`
Defines the names of the storages the metric defaults to when "default" is used as the destination storage. Note that every metric type will need to override this. | +| [disabled](disabled.md) | `abstract val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [identifier](identifier.md) | `open val identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [lifetime](lifetime.md) | `abstract val lifetime: `[`Lifetime`](../-lifetime/index.md) | +| [name](name.md) | `abstract val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [sendInPings](send-in-pings.md) | `abstract val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` | + +### Functions + +| Name | Summary | +|---|---| +| [getStorageNames](get-storage-names.md) | `open fun getStorageNames(): `[`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)`>`
Get the list of storage names the metric will record to. This automatically expands [DEFAULT_STORAGE_NAME](#) to the list of default storages for the metric. | +| [shouldRecord](should-record.md) | `open fun shouldRecord(logger: `[`Logger`](../../mozilla.components.support.base.log.logger/-logger/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [BooleanMetricType](../-boolean-metric-type/index.md) | `data class BooleanMetricType : `[`CommonMetricData`](./index.md)
This implements the developer facing API for recording boolean metrics. | +| [CounterMetricType](../-counter-metric-type/index.md) | `data class CounterMetricType : `[`CommonMetricData`](./index.md)
This implements the developer facing API for recording counter metrics. | +| [EventMetricType](../-event-metric-type/index.md) | `data class EventMetricType : `[`CommonMetricData`](./index.md)
This implements the developer facing API for recording events. | +| [StringListMetricType](../-string-list-metric-type/index.md) | `data class StringListMetricType : `[`CommonMetricData`](./index.md)
This implements the developer facing API for recording string list metrics. | +| [StringMetricType](../-string-metric-type/index.md) | `data class StringMetricType : `[`CommonMetricData`](./index.md)
This implements the developer facing API for recording string metrics. | +| [TimespanMetricType](../-timespan-metric-type/index.md) | `data class TimespanMetricType : `[`CommonMetricData`](./index.md)
This implements the developer facing API for recording timespans. | +| [UuidMetricType](../-uuid-metric-type/index.md) | `data class UuidMetricType : `[`CommonMetricData`](./index.md)
This implements the developer facing API for recording uuids. | diff --git a/docs/api/mozilla.components.service.glean/-common-metric-data/lifetime.md b/docs/api/mozilla.components.service.glean/-common-metric-data/lifetime.md new file mode 100644 index 00000000000..9f7a624bd21 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-common-metric-data/lifetime.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CommonMetricData](index.md) / [lifetime](./lifetime.md) + +# lifetime + +`abstract val lifetime: `[`Lifetime`](../-lifetime/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CommonMetricData.kt#L34) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-common-metric-data/name.md b/docs/api/mozilla.components.service.glean/-common-metric-data/name.md new file mode 100644 index 00000000000..bc1e54efd7c --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-common-metric-data/name.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CommonMetricData](index.md) / [name](./name.md) + +# name + +`abstract val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CommonMetricData.kt#L35) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-common-metric-data/send-in-pings.md b/docs/api/mozilla.components.service.glean/-common-metric-data/send-in-pings.md new file mode 100644 index 00000000000..2c99824a039 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-common-metric-data/send-in-pings.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CommonMetricData](index.md) / [sendInPings](./send-in-pings.md) + +# sendInPings + +`abstract val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CommonMetricData.kt#L36) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-common-metric-data/should-record.md b/docs/api/mozilla.components.service.glean/-common-metric-data/should-record.md new file mode 100644 index 00000000000..1eb9d878a62 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-common-metric-data/should-record.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CommonMetricData](index.md) / [shouldRecord](./should-record.md) + +# shouldRecord + +`open fun shouldRecord(logger: `[`Logger`](../../mozilla.components.support.base.log.logger/-logger/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CommonMetricData.kt#L44) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-counter-metric-type/-init-.md b/docs/api/mozilla.components.service.glean/-counter-metric-type/-init-.md new file mode 100644 index 00000000000..43b0f52ac42 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-counter-metric-type/-init-.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CounterMetricType](index.md) / [<init>](./-init-.md) + +# <init> + +`CounterMetricType(disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, lifetime: `[`Lifetime`](../-lifetime/index.md)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>)` + +This implements the developer facing API for recording counter metrics. + +Instances of this class type are automatically generated by the parsers at build time, +allowing developers to record values that were previously registered in the metrics.yaml file. + +The counter API only exposes the [add](add.md) method, which takes care of validating the input +data and making sure that limits are enforced. + diff --git a/docs/api/mozilla.components.service.glean/-counter-metric-type/add.md b/docs/api/mozilla.components.service.glean/-counter-metric-type/add.md new file mode 100644 index 00000000000..99f15a8b5f4 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-counter-metric-type/add.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CounterMetricType](index.md) / [add](./add.md) + +# add + +`fun add(amount: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 1): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CounterMetricType.kt#L39) + +Add to counter value. + +### Parameters + +`amount` - This is the amount to increment the counter by, defaulting to 1 if called +without parameters. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-counter-metric-type/category.md b/docs/api/mozilla.components.service.glean/-counter-metric-type/category.md new file mode 100644 index 00000000000..b06132a7b07 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-counter-metric-type/category.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CounterMetricType](index.md) / [category](./category.md) + +# category + +`val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CounterMetricType.kt#L23) + +Overrides [CommonMetricData.category](../-common-metric-data/category.md) + diff --git a/docs/api/mozilla.components.service.glean/-counter-metric-type/default-storage-destinations.md b/docs/api/mozilla.components.service.glean/-counter-metric-type/default-storage-destinations.md new file mode 100644 index 00000000000..3636951f699 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-counter-metric-type/default-storage-destinations.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CounterMetricType](index.md) / [defaultStorageDestinations](./default-storage-destinations.md) + +# defaultStorageDestinations + +`val defaultStorageDestinations: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CounterMetricType.kt#L29) + +Overrides [CommonMetricData.defaultStorageDestinations](../-common-metric-data/default-storage-destinations.md) + +Defines the names of the storages the metric defaults to when +"default" is used as the destination storage. +Note that every metric type will need to override this. + diff --git a/docs/api/mozilla.components.service.glean/-counter-metric-type/disabled.md b/docs/api/mozilla.components.service.glean/-counter-metric-type/disabled.md new file mode 100644 index 00000000000..9eb10d94f09 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-counter-metric-type/disabled.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CounterMetricType](index.md) / [disabled](./disabled.md) + +# disabled + +`val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CounterMetricType.kt#L22) + +Overrides [CommonMetricData.disabled](../-common-metric-data/disabled.md) + diff --git a/docs/api/mozilla.components.service.glean/-counter-metric-type/index.md b/docs/api/mozilla.components.service.glean/-counter-metric-type/index.md new file mode 100644 index 00000000000..2915f049233 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-counter-metric-type/index.md @@ -0,0 +1,51 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CounterMetricType](./index.md) + +# CounterMetricType + +`data class CounterMetricType : `[`CommonMetricData`](../-common-metric-data/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CounterMetricType.kt#L21) + +This implements the developer facing API for recording counter metrics. + +Instances of this class type are automatically generated by the parsers at build time, +allowing developers to record values that were previously registered in the metrics.yaml file. + +The counter API only exposes the [add](add.md) method, which takes care of validating the input +data and making sure that limits are enforced. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `CounterMetricType(disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, lifetime: `[`Lifetime`](../-lifetime/index.md)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>)`
This implements the developer facing API for recording counter metrics. | + +### Properties + +| Name | Summary | +|---|---| +| [category](category.md) | `val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [defaultStorageDestinations](default-storage-destinations.md) | `val defaultStorageDestinations: `[`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)`>`
Defines the names of the storages the metric defaults to when "default" is used as the destination storage. Note that every metric type will need to override this. | +| [disabled](disabled.md) | `val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [lifetime](lifetime.md) | `val lifetime: `[`Lifetime`](../-lifetime/index.md) | +| [name](name.md) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [sendInPings](send-in-pings.md) | `val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [identifier](../-common-metric-data/identifier.md) | `open val identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [add](add.md) | `fun add(amount: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 1): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Add to counter value. | +| [testGetValue](test-get-value.md) | `fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns the stored value for testing purposes only | +| [testHasValue](test-has-value.md) | `fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Tests whether a value is stored for the metric for testing purposes only | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getStorageNames](../-common-metric-data/get-storage-names.md) | `open fun getStorageNames(): `[`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)`>`
Get the list of storage names the metric will record to. This automatically expands [DEFAULT_STORAGE_NAME](#) to the list of default storages for the metric. | +| [shouldRecord](../-common-metric-data/should-record.md) | `open fun shouldRecord(logger: `[`Logger`](../../mozilla.components.support.base.log.logger/-logger/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | diff --git a/docs/api/mozilla.components.service.glean/-counter-metric-type/lifetime.md b/docs/api/mozilla.components.service.glean/-counter-metric-type/lifetime.md new file mode 100644 index 00000000000..9db3e56c199 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-counter-metric-type/lifetime.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CounterMetricType](index.md) / [lifetime](./lifetime.md) + +# lifetime + +`val lifetime: `[`Lifetime`](../-lifetime/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CounterMetricType.kt#L24) + +Overrides [CommonMetricData.lifetime](../-common-metric-data/lifetime.md) + diff --git a/docs/api/mozilla.components.service.glean/-counter-metric-type/name.md b/docs/api/mozilla.components.service.glean/-counter-metric-type/name.md new file mode 100644 index 00000000000..3299e3b41f4 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-counter-metric-type/name.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CounterMetricType](index.md) / [name](./name.md) + +# name + +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CounterMetricType.kt#L25) + +Overrides [CommonMetricData.name](../-common-metric-data/name.md) + diff --git a/docs/api/mozilla.components.service.glean/-counter-metric-type/send-in-pings.md b/docs/api/mozilla.components.service.glean/-counter-metric-type/send-in-pings.md new file mode 100644 index 00000000000..e5c0739aa17 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-counter-metric-type/send-in-pings.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CounterMetricType](index.md) / [sendInPings](./send-in-pings.md) + +# sendInPings + +`val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CounterMetricType.kt#L26) + +Overrides [CommonMetricData.sendInPings](../-common-metric-data/send-in-pings.md) + diff --git a/docs/api/mozilla.components.service.glean/-counter-metric-type/test-get-value.md b/docs/api/mozilla.components.service.glean/-counter-metric-type/test-get-value.md new file mode 100644 index 00000000000..a344d69894d --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-counter-metric-type/test-get-value.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CounterMetricType](index.md) / [testGetValue](./test-get-value.md) + +# testGetValue + +`fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CounterMetricType.kt#L83) + +Returns the stored value for testing purposes only + +### Parameters + +`pingName` - represents the name of the ping to retrieve the metric for. Defaults + to the either the first value in [defaultStorageDestinations](default-storage-destinations.md) or the first + value in [sendInPings](send-in-pings.md) + +### Exceptions + +`NullPointerException` - if no value is stored + +**Return** +value of the stored metric + diff --git a/docs/api/mozilla.components.service.glean/-counter-metric-type/test-has-value.md b/docs/api/mozilla.components.service.glean/-counter-metric-type/test-has-value.md new file mode 100644 index 00000000000..0859e903cf3 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-counter-metric-type/test-has-value.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [CounterMetricType](index.md) / [testHasValue](./test-has-value.md) + +# testHasValue + +`fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CounterMetricType.kt#L69) + +Tests whether a value is stored for the metric for testing purposes only + +### Parameters + +`pingName` - represents the name of the ping to retrieve the metric for. Defaults + to the either the first value in [defaultStorageDestinations](default-storage-destinations.md) or the first + value in [sendInPings](send-in-pings.md) + +**Return** +true if metric value exists, otherwise false + diff --git a/docs/api/mozilla.components.service.glean/-event-metric-type/-init-.md b/docs/api/mozilla.components.service.glean/-event-metric-type/-init-.md new file mode 100644 index 00000000000..985bef8e12d --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-event-metric-type/-init-.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [EventMetricType](index.md) / [<init>](./-init-.md) + +# <init> + +`EventMetricType(disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, lifetime: `[`Lifetime`](../-lifetime/index.md)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>, objects: `[`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)`>, allowedExtraKeys: `[`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)` + +This implements the developer facing API for recording events. + +Instances of this class type are automatically generated by the parsers at built time, +allowing developers to record events that were previously registered in the metrics.yaml file. + +The Events API only exposes the [record](record.md) method, which takes care of validating the input +data and making sure that limits are enforced. + diff --git a/docs/api/mozilla.components.service.glean/-event-metric-type/allowed-extra-keys.md b/docs/api/mozilla.components.service.glean/-event-metric-type/allowed-extra-keys.md new file mode 100644 index 00000000000..763fbfebe6d --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-event-metric-type/allowed-extra-keys.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [EventMetricType](index.md) / [allowedExtraKeys](./allowed-extra-keys.md) + +# allowedExtraKeys + +`val allowedExtraKeys: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/EventMetricType.kt#L29) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-event-metric-type/category.md b/docs/api/mozilla.components.service.glean/-event-metric-type/category.md new file mode 100644 index 00000000000..c183a7c3be7 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-event-metric-type/category.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [EventMetricType](index.md) / [category](./category.md) + +# category + +`val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/EventMetricType.kt#L24) + +Overrides [CommonMetricData.category](../-common-metric-data/category.md) + diff --git a/docs/api/mozilla.components.service.glean/-event-metric-type/default-storage-destinations.md b/docs/api/mozilla.components.service.glean/-event-metric-type/default-storage-destinations.md new file mode 100644 index 00000000000..4b6c2cc5c66 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-event-metric-type/default-storage-destinations.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [EventMetricType](index.md) / [defaultStorageDestinations](./default-storage-destinations.md) + +# defaultStorageDestinations + +`val defaultStorageDestinations: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/EventMetricType.kt#L32) + +Overrides [CommonMetricData.defaultStorageDestinations](../-common-metric-data/default-storage-destinations.md) + +Defines the names of the storages the metric defaults to when +"default" is used as the destination storage. +Note that every metric type will need to override this. + diff --git a/docs/api/mozilla.components.service.glean/-event-metric-type/disabled.md b/docs/api/mozilla.components.service.glean/-event-metric-type/disabled.md new file mode 100644 index 00000000000..9afb1d953d3 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-event-metric-type/disabled.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [EventMetricType](index.md) / [disabled](./disabled.md) + +# disabled + +`val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/EventMetricType.kt#L23) + +Overrides [CommonMetricData.disabled](../-common-metric-data/disabled.md) + diff --git a/docs/api/mozilla.components.service.glean/-event-metric-type/index.md b/docs/api/mozilla.components.service.glean/-event-metric-type/index.md new file mode 100644 index 00000000000..6d44c000608 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-event-metric-type/index.md @@ -0,0 +1,53 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [EventMetricType](./index.md) + +# EventMetricType + +`data class EventMetricType : `[`CommonMetricData`](../-common-metric-data/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/EventMetricType.kt#L22) + +This implements the developer facing API for recording events. + +Instances of this class type are automatically generated by the parsers at built time, +allowing developers to record events that were previously registered in the metrics.yaml file. + +The Events API only exposes the [record](record.md) method, which takes care of validating the input +data and making sure that limits are enforced. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `EventMetricType(disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, lifetime: `[`Lifetime`](../-lifetime/index.md)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>, objects: `[`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)`>, allowedExtraKeys: `[`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)`
This implements the developer facing API for recording events. | + +### Properties + +| Name | Summary | +|---|---| +| [allowedExtraKeys](allowed-extra-keys.md) | `val allowedExtraKeys: `[`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)`>?` | +| [category](category.md) | `val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [defaultStorageDestinations](default-storage-destinations.md) | `val defaultStorageDestinations: `[`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)`>`
Defines the names of the storages the metric defaults to when "default" is used as the destination storage. Note that every metric type will need to override this. | +| [disabled](disabled.md) | `val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [lifetime](lifetime.md) | `val lifetime: `[`Lifetime`](../-lifetime/index.md) | +| [name](name.md) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [objects](objects.md) | `val objects: `[`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)`>` | +| [sendInPings](send-in-pings.md) | `val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [identifier](../-common-metric-data/identifier.md) | `open val identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [record](record.md) | `fun record(objectId: `[`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)`? = null, extra: `[`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): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Record an event by using the information provided by the instance of this class. | +| [testGetValue](test-get-value.md) | `fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`RecordedEventData`](../../mozilla.components.service.glean.storages/-recorded-event-data/index.md)`>`
Returns the stored value for testing purposes only | +| [testHasValue](test-has-value.md) | `fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Tests whether a value is stored for the metric for testing purposes only | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getStorageNames](../-common-metric-data/get-storage-names.md) | `open fun getStorageNames(): `[`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)`>`
Get the list of storage names the metric will record to. This automatically expands [DEFAULT_STORAGE_NAME](#) to the list of default storages for the metric. | +| [shouldRecord](../-common-metric-data/should-record.md) | `open fun shouldRecord(logger: `[`Logger`](../../mozilla.components.support.base.log.logger/-logger/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | diff --git a/docs/api/mozilla.components.service.glean/-event-metric-type/lifetime.md b/docs/api/mozilla.components.service.glean/-event-metric-type/lifetime.md new file mode 100644 index 00000000000..5145a53592a --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-event-metric-type/lifetime.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [EventMetricType](index.md) / [lifetime](./lifetime.md) + +# lifetime + +`val lifetime: `[`Lifetime`](../-lifetime/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/EventMetricType.kt#L25) + +Overrides [CommonMetricData.lifetime](../-common-metric-data/lifetime.md) + diff --git a/docs/api/mozilla.components.service.glean/-event-metric-type/name.md b/docs/api/mozilla.components.service.glean/-event-metric-type/name.md new file mode 100644 index 00000000000..ad9215f7b9f --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-event-metric-type/name.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [EventMetricType](index.md) / [name](./name.md) + +# name + +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/EventMetricType.kt#L26) + +Overrides [CommonMetricData.name](../-common-metric-data/name.md) + diff --git a/docs/api/mozilla.components.service.glean/-event-metric-type/objects.md b/docs/api/mozilla.components.service.glean/-event-metric-type/objects.md new file mode 100644 index 00000000000..175cfd9a86b --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-event-metric-type/objects.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [EventMetricType](index.md) / [objects](./objects.md) + +# objects + +`val objects: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/EventMetricType.kt#L28) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-event-metric-type/record.md b/docs/api/mozilla.components.service.glean/-event-metric-type/record.md new file mode 100644 index 00000000000..dfdf57c8c71 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-event-metric-type/record.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [EventMetricType](index.md) / [record](./record.md) + +# record + +`fun record(objectId: `[`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)`? = null, extra: `[`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): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/EventMetricType.kt#L55) + +Record an event by using the information provided by the instance of this class. + +### Parameters + +`objectId` - the object the event occurred on, e.g. 'reload_button'. The maximum + length of this string is defined by [MAX_LENGTH_OBJECT_ID](#) + +`value` - optional. This is a user defined value, providing context for the event. The + maximum length of this string is defined by [MAX_LENGTH_VALUE](#) + +`extra` - optional. This is map, both keys and values need to be strings, keys are + identifiers. This is used for events where additional richer context is needed. + The maximum length for values is defined by [MAX_LENGTH_EXTRA_KEY_VALUE](#) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-event-metric-type/send-in-pings.md b/docs/api/mozilla.components.service.glean/-event-metric-type/send-in-pings.md new file mode 100644 index 00000000000..a807bdd9573 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-event-metric-type/send-in-pings.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [EventMetricType](index.md) / [sendInPings](./send-in-pings.md) + +# sendInPings + +`val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/EventMetricType.kt#L27) + +Overrides [CommonMetricData.sendInPings](../-common-metric-data/send-in-pings.md) + diff --git a/docs/api/mozilla.components.service.glean/-event-metric-type/test-get-value.md b/docs/api/mozilla.components.service.glean/-event-metric-type/test-get-value.md new file mode 100644 index 00000000000..550ce54b9fc --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-event-metric-type/test-get-value.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [EventMetricType](index.md) / [testGetValue](./test-get-value.md) + +# testGetValue + +`fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`RecordedEventData`](../../mozilla.components.service.glean.storages/-recorded-event-data/index.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/EventMetricType.kt#L141) + +Returns the stored value for testing purposes only + +### Parameters + +`pingName` - represents the name of the ping to retrieve the metric for. Defaults + to the either the first value in [defaultStorageDestinations](default-storage-destinations.md) or the first + value in [sendInPings](send-in-pings.md) + +### Exceptions + +`NullPointerException` - if no value is stored + +**Return** +value of the stored metric + diff --git a/docs/api/mozilla.components.service.glean/-event-metric-type/test-has-value.md b/docs/api/mozilla.components.service.glean/-event-metric-type/test-has-value.md new file mode 100644 index 00000000000..f33421b5c18 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-event-metric-type/test-has-value.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [EventMetricType](index.md) / [testHasValue](./test-has-value.md) + +# testHasValue + +`fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/EventMetricType.kt#L124) + +Tests whether a value is stored for the metric for testing purposes only + +### Parameters + +`pingName` - represents the name of the ping to retrieve the metric for. Defaults + to the either the first value in [defaultStorageDestinations](default-storage-destinations.md) or the first + value in [sendInPings](send-in-pings.md) + +**Return** +true if metric value exists, otherwise false + diff --git a/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/get-upload-enabled.md b/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/get-upload-enabled.md new file mode 100644 index 00000000000..5217f5e75ca --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/get-upload-enabled.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [GleanInternalAPI](index.md) / [getUploadEnabled](./get-upload-enabled.md) + +# getUploadEnabled + +`fun getUploadEnabled(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/Glean.kt#L118) + +Get whether or not glean is allowed to record and upload data. + diff --git a/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/handle-event.md b/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/handle-event.md new file mode 100644 index 00000000000..5305a41f2b0 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/handle-event.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [GleanInternalAPI](index.md) / [handleEvent](./handle-event.md) + +# handleEvent + +`fun handleEvent(pingEvent: `[`PingEvent`](../-glean/-ping-event/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/Glean.kt#L253) + +Handle an event and send the appropriate pings. + +Valid events are: + +* Background: When the application goes to the background. + This triggers sending of the baseline ping. +* Default: Event that triggers the default pings. + +### Parameters + +`pingEvent` - The type of the event. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/index.md b/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/index.md new file mode 100644 index 00000000000..832ab0fed45 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [GleanInternalAPI](./index.md) + +# GleanInternalAPI + +`open class GleanInternalAPI` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/Glean.kt#L31) + +### Functions + +| Name | Summary | +|---|---| +| [getUploadEnabled](get-upload-enabled.md) | `fun getUploadEnabled(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Get whether or not glean is allowed to record and upload data. | +| [handleEvent](handle-event.md) | `fun handleEvent(pingEvent: `[`PingEvent`](../-glean/-ping-event/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Handle an event and send the appropriate pings. | +| [initialize](initialize.md) | `fun initialize(applicationContext: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, configuration: `[`Configuration`](../../mozilla.components.service.glean.config/-configuration/index.md)` = Configuration()): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Initialize glean. | +| [setExperimentActive](set-experiment-active.md) | `fun setExperimentActive(experimentId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, branch: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, extra: `[`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): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Indicate that an experiment is running. Glean will then add an experiment annotation to the environment which is sent with pings. This information is not persisted between runs. | +| [setExperimentInactive](set-experiment-inactive.md) | `fun setExperimentInactive(experimentId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Indicate that an experiment is no longer running. | +| [setUploadEnabled](set-upload-enabled.md) | `fun setUploadEnabled(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)
Enable or disable glean collection and upload. | +| [testClearAllData](test-clear-all-data.md) | `fun testClearAllData(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Test only function to clear all storages and metrics. Note that this also includes 'user' lifetime metrics so be aware that things like clientId will be wiped as well. | + +### Inheritors + +| Name | Summary | +|---|---| +| [Glean](../-glean/index.md) | `object Glean : `[`GleanInternalAPI`](./index.md) | diff --git a/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/initialize.md b/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/initialize.md new file mode 100644 index 00000000000..13627331e3d --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/initialize.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [GleanInternalAPI](index.md) / [initialize](./initialize.md) + +# initialize + +`fun initialize(applicationContext: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, configuration: `[`Configuration`](../../mozilla.components.service.glean.config/-configuration/index.md)` = Configuration()): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/Glean.kt#L72) + +Initialize glean. + +This should only be initialized once by the application, and not by +libraries using glean. A message is logged to error and no changes are made +to the state if initialize is called a more than once. + +A LifecycleObserver will be added to send pings when the application goes +into the background. + +### Parameters + +`applicationContext` - [Context](https://developer.android.com/reference/android/content/Context.html) to access application features, such +as shared preferences + +`configuration` - A Glean [Configuration](../../mozilla.components.service.glean.config/-configuration/index.md) object with global settings. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/set-experiment-active.md b/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/set-experiment-active.md new file mode 100644 index 00000000000..97a496362a7 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/set-experiment-active.md @@ -0,0 +1,18 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [GleanInternalAPI](index.md) / [setExperimentActive](./set-experiment-active.md) + +# setExperimentActive + +`fun setExperimentActive(experimentId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, branch: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, extra: `[`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): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/Glean.kt#L132) + +Indicate that an experiment is running. Glean will then add an +experiment annotation to the environment which is sent with pings. This +information is not persisted between runs. + +### Parameters + +`experimentId` - The id of the active experiment (maximum + 30 bytes) + +`branch` - The experiment branch (maximum 30 bytes) + +`extra` - Optional metadata to output with the ping \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/set-experiment-inactive.md b/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/set-experiment-inactive.md new file mode 100644 index 00000000000..f3782d8a70c --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/set-experiment-inactive.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [GleanInternalAPI](index.md) / [setExperimentInactive](./set-experiment-inactive.md) + +# setExperimentInactive + +`fun setExperimentInactive(experimentId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/Glean.kt#L145) + +Indicate that an experiment is no longer running. + +### Parameters + +`experimentId` - The id of the experiment to deactivate. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/set-upload-enabled.md b/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/set-upload-enabled.md new file mode 100644 index 00000000000..9d55aa3f22b --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/set-upload-enabled.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [GleanInternalAPI](index.md) / [setUploadEnabled](./set-upload-enabled.md) + +# setUploadEnabled + +`fun setUploadEnabled(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/Glean.kt#L110) + +Enable or disable glean collection and upload. + +Metric collection is enabled by default. + +When disabled, metrics aren't recorded at all and no data +is uploaded. + +### Parameters + +`enabled` - When true, enable metric collection. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/test-clear-all-data.md b/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/test-clear-all-data.md new file mode 100644 index 00000000000..96a1e252bf5 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-glean-internal-a-p-i/test-clear-all-data.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [GleanInternalAPI](index.md) / [testClearAllData](./test-clear-all-data.md) + +# testClearAllData + +`fun testClearAllData(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/Glean.kt#L278) + +Test only function to clear all storages and metrics. Note that this also includes 'user' +lifetime metrics so be aware that things like clientId will be wiped as well. + diff --git a/docs/api/mozilla.components.service.glean/-glean/-ping-event/-background.md b/docs/api/mozilla.components.service.glean/-glean/-ping-event/-background.md new file mode 100644 index 00000000000..907fbe9118b --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-glean/-ping-event/-background.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.service.glean](../../index.md) / [Glean](../index.md) / [PingEvent](index.md) / [Background](./-background.md) + +# Background + +`Background` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/Glean.kt#L291) + +When the application goes into the background + diff --git a/docs/api/mozilla.components.service.glean/-glean/-ping-event/-default.md b/docs/api/mozilla.components.service.glean/-glean/-ping-event/-default.md new file mode 100644 index 00000000000..8d1c1bf4942 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-glean/-ping-event/-default.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [mozilla.components.service.glean](../../index.md) / [Glean](../index.md) / [PingEvent](index.md) / [Default](./-default.md) + +# Default + +`Default` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/Glean.kt#L295) + +A periodic event to send the default ping + diff --git a/docs/api/mozilla.components.service.glean/-glean/-ping-event/index.md b/docs/api/mozilla.components.service.glean/-glean/-ping-event/index.md new file mode 100644 index 00000000000..f001177bcd5 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-glean/-ping-event/index.md @@ -0,0 +1,14 @@ +[android-components](../../../index.md) / [mozilla.components.service.glean](../../index.md) / [Glean](../index.md) / [PingEvent](./index.md) + +# PingEvent + +`enum class PingEvent` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/Glean.kt#L287) + +Enumeration of different metric lifetimes. + +### Enum Values + +| Name | Summary | +|---|---| +| [Background](-background.md) | When the application goes into the background | +| [Default](-default.md) | A periodic event to send the default ping | diff --git a/docs/api/mozilla.components.service.glean/-glean/index.md b/docs/api/mozilla.components.service.glean/-glean/index.md new file mode 100644 index 00000000000..678914b54dd --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-glean/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [Glean](./index.md) + +# Glean + +`object Glean : `[`GleanInternalAPI`](../-glean-internal-a-p-i/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/Glean.kt#L283) + +### Types + +| Name | Summary | +|---|---| +| [PingEvent](-ping-event/index.md) | `enum class PingEvent`
Enumeration of different metric lifetimes. | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getUploadEnabled](../-glean-internal-a-p-i/get-upload-enabled.md) | `fun getUploadEnabled(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Get whether or not glean is allowed to record and upload data. | +| [handleEvent](../-glean-internal-a-p-i/handle-event.md) | `fun handleEvent(pingEvent: `[`PingEvent`](-ping-event/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Handle an event and send the appropriate pings. | +| [initialize](../-glean-internal-a-p-i/initialize.md) | `fun initialize(applicationContext: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, configuration: `[`Configuration`](../../mozilla.components.service.glean.config/-configuration/index.md)` = Configuration()): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Initialize glean. | +| [setExperimentActive](../-glean-internal-a-p-i/set-experiment-active.md) | `fun setExperimentActive(experimentId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, branch: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, extra: `[`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): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Indicate that an experiment is running. Glean will then add an experiment annotation to the environment which is sent with pings. This information is not persisted between runs. | +| [setExperimentInactive](../-glean-internal-a-p-i/set-experiment-inactive.md) | `fun setExperimentInactive(experimentId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Indicate that an experiment is no longer running. | +| [setUploadEnabled](../-glean-internal-a-p-i/set-upload-enabled.md) | `fun setUploadEnabled(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)
Enable or disable glean collection and upload. | +| [testClearAllData](../-glean-internal-a-p-i/test-clear-all-data.md) | `fun testClearAllData(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Test only function to clear all storages and metrics. Note that this also includes 'user' lifetime metrics so be aware that things like clientId will be wiped as well. | diff --git a/docs/api/mozilla.components.service.glean/-lifetime/-application.md b/docs/api/mozilla.components.service.glean/-lifetime/-application.md new file mode 100644 index 00000000000..e203868b7a0 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-lifetime/-application.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [Lifetime](index.md) / [Application](./-application.md) + +# Application + +`Application` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CommonMetricData.kt#L20) + +The metric is reset on application restart + diff --git a/docs/api/mozilla.components.service.glean/-lifetime/-ping.md b/docs/api/mozilla.components.service.glean/-lifetime/-ping.md new file mode 100644 index 00000000000..63380cf6e84 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-lifetime/-ping.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [Lifetime](index.md) / [Ping](./-ping.md) + +# Ping + +`Ping` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CommonMetricData.kt#L16) + +The metric is reset with each sent ping + diff --git a/docs/api/mozilla.components.service.glean/-lifetime/-user.md b/docs/api/mozilla.components.service.glean/-lifetime/-user.md new file mode 100644 index 00000000000..36245664c43 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-lifetime/-user.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [Lifetime](index.md) / [User](./-user.md) + +# User + +`User` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CommonMetricData.kt#L24) + +The metric is reset with each user profile + diff --git a/docs/api/mozilla.components.service.glean/-lifetime/index.md b/docs/api/mozilla.components.service.glean/-lifetime/index.md new file mode 100644 index 00000000000..24659fd9084 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-lifetime/index.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [Lifetime](./index.md) + +# Lifetime + +`enum class Lifetime` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/CommonMetricData.kt#L12) + +Enumeration of different metric lifetimes. + +### Enum Values + +| Name | Summary | +|---|---| +| [Ping](-ping.md) | The metric is reset with each sent ping | +| [Application](-application.md) | The metric is reset on application restart | +| [User](-user.md) | The metric is reset with each user profile | diff --git a/docs/api/mozilla.components.service.glean/-string-list-metric-type/-init-.md b/docs/api/mozilla.components.service.glean/-string-list-metric-type/-init-.md new file mode 100644 index 00000000000..25375752468 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-list-metric-type/-init-.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringListMetricType](index.md) / [<init>](./-init-.md) + +# <init> + +`StringListMetricType(disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, lifetime: `[`Lifetime`](../-lifetime/index.md)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>)` + +This implements the developer facing API for recording string list metrics. + +Instances of this class type are automatically generated by the parsers at build time, +allowing developers to record values that were previously registered in the metrics.yaml file. + +The string list API exposes the [add](add.md) and [set](set.md) methods, which take care of validating the input +data and making sure that limits are enforced. + diff --git a/docs/api/mozilla.components.service.glean/-string-list-metric-type/-m-a-x_-s-t-r-i-n-g_-l-e-n-g-t-h.md b/docs/api/mozilla.components.service.glean/-string-list-metric-type/-m-a-x_-s-t-r-i-n-g_-l-e-n-g-t-h.md new file mode 100644 index 00000000000..658f3905f94 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-list-metric-type/-m-a-x_-s-t-r-i-n-g_-l-e-n-g-t-h.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringListMetricType](index.md) / [MAX_STRING_LENGTH](./-m-a-x_-s-t-r-i-n-g_-l-e-n-g-t-h.md) + +# MAX_STRING_LENGTH + +`const val MAX_STRING_LENGTH: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringListMetricType.kt#L35) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-string-list-metric-type/add.md b/docs/api/mozilla.components.service.glean/-string-list-metric-type/add.md new file mode 100644 index 00000000000..67e0e16b6bf --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-list-metric-type/add.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringListMetricType](index.md) / [add](./add.md) + +# add + +`fun add(value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringListMetricType.kt#L49) + +Appends a string value to one or more string list metric stores. If the string exceeds the +maximum string length, defined as [MAX_STRING_LENGTH](-m-a-x_-s-t-r-i-n-g_-l-e-n-g-t-h.md), it will be truncated. + +If adding the string to the lists would exceed the maximum value defined as +[StringListsStorageEngine.MAX_LIST_LENGTH_VALUE](#), then the storage engine will drop the new +value and it will not be added to the list. + +### Parameters + +`value` - This is a user defined string value. The maximum length of + this string is [MAX_STRING_LENGTH](-m-a-x_-s-t-r-i-n-g_-l-e-n-g-t-h.md). \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-string-list-metric-type/category.md b/docs/api/mozilla.components.service.glean/-string-list-metric-type/category.md new file mode 100644 index 00000000000..b4a138d9071 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-list-metric-type/category.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringListMetricType](index.md) / [category](./category.md) + +# category + +`val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringListMetricType.kt#L23) + +Overrides [CommonMetricData.category](../-common-metric-data/category.md) + diff --git a/docs/api/mozilla.components.service.glean/-string-list-metric-type/default-storage-destinations.md b/docs/api/mozilla.components.service.glean/-string-list-metric-type/default-storage-destinations.md new file mode 100644 index 00000000000..f4ecd75fff3 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-list-metric-type/default-storage-destinations.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringListMetricType](index.md) / [defaultStorageDestinations](./default-storage-destinations.md) + +# defaultStorageDestinations + +`val defaultStorageDestinations: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringListMetricType.kt#L29) + +Overrides [CommonMetricData.defaultStorageDestinations](../-common-metric-data/default-storage-destinations.md) + +Defines the names of the storages the metric defaults to when +"default" is used as the destination storage. +Note that every metric type will need to override this. + diff --git a/docs/api/mozilla.components.service.glean/-string-list-metric-type/disabled.md b/docs/api/mozilla.components.service.glean/-string-list-metric-type/disabled.md new file mode 100644 index 00000000000..1fd6491abe3 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-list-metric-type/disabled.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringListMetricType](index.md) / [disabled](./disabled.md) + +# disabled + +`val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringListMetricType.kt#L22) + +Overrides [CommonMetricData.disabled](../-common-metric-data/disabled.md) + diff --git a/docs/api/mozilla.components.service.glean/-string-list-metric-type/index.md b/docs/api/mozilla.components.service.glean/-string-list-metric-type/index.md new file mode 100644 index 00000000000..7749a3d3d3e --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-list-metric-type/index.md @@ -0,0 +1,58 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringListMetricType](./index.md) + +# StringListMetricType + +`data class StringListMetricType : `[`CommonMetricData`](../-common-metric-data/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringListMetricType.kt#L21) + +This implements the developer facing API for recording string list metrics. + +Instances of this class type are automatically generated by the parsers at build time, +allowing developers to record values that were previously registered in the metrics.yaml file. + +The string list API exposes the [add](add.md) and [set](set.md) methods, which take care of validating the input +data and making sure that limits are enforced. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `StringListMetricType(disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, lifetime: `[`Lifetime`](../-lifetime/index.md)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>)`
This implements the developer facing API for recording string list metrics. | + +### Properties + +| Name | Summary | +|---|---| +| [category](category.md) | `val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [defaultStorageDestinations](default-storage-destinations.md) | `val defaultStorageDestinations: `[`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)`>`
Defines the names of the storages the metric defaults to when "default" is used as the destination storage. Note that every metric type will need to override this. | +| [disabled](disabled.md) | `val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [lifetime](lifetime.md) | `val lifetime: `[`Lifetime`](../-lifetime/index.md) | +| [name](name.md) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [sendInPings](send-in-pings.md) | `val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [identifier](../-common-metric-data/identifier.md) | `open val identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [add](add.md) | `fun add(value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Appends a string value to one or more string list metric stores. If the string exceeds the maximum string length, defined as [MAX_STRING_LENGTH](-m-a-x_-s-t-r-i-n-g_-l-e-n-g-t-h.md), it will be truncated. | +| [set](set.md) | `fun set(value: `[`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)
Sets a string list to one or more metric stores. | +| [testGetValue](test-get-value.md) | `fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`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)`>`
Returns the stored value for testing purposes only | +| [testHasValue](test-has-value.md) | `fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Tests whether a value is stored for the metric for testing purposes only | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getStorageNames](../-common-metric-data/get-storage-names.md) | `open fun getStorageNames(): `[`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)`>`
Get the list of storage names the metric will record to. This automatically expands [DEFAULT_STORAGE_NAME](#) to the list of default storages for the metric. | +| [shouldRecord](../-common-metric-data/should-record.md) | `open fun shouldRecord(logger: `[`Logger`](../../mozilla.components.support.base.log.logger/-logger/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +### Companion Object Properties + +| Name | Summary | +|---|---| +| [MAX_STRING_LENGTH](-m-a-x_-s-t-r-i-n-g_-l-e-n-g-t-h.md) | `const val MAX_STRING_LENGTH: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/mozilla.components.service.glean/-string-list-metric-type/lifetime.md b/docs/api/mozilla.components.service.glean/-string-list-metric-type/lifetime.md new file mode 100644 index 00000000000..46eba6084ee --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-list-metric-type/lifetime.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringListMetricType](index.md) / [lifetime](./lifetime.md) + +# lifetime + +`val lifetime: `[`Lifetime`](../-lifetime/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringListMetricType.kt#L24) + +Overrides [CommonMetricData.lifetime](../-common-metric-data/lifetime.md) + diff --git a/docs/api/mozilla.components.service.glean/-string-list-metric-type/name.md b/docs/api/mozilla.components.service.glean/-string-list-metric-type/name.md new file mode 100644 index 00000000000..d26b0853959 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-list-metric-type/name.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringListMetricType](index.md) / [name](./name.md) + +# name + +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringListMetricType.kt#L25) + +Overrides [CommonMetricData.name](../-common-metric-data/name.md) + diff --git a/docs/api/mozilla.components.service.glean/-string-list-metric-type/send-in-pings.md b/docs/api/mozilla.components.service.glean/-string-list-metric-type/send-in-pings.md new file mode 100644 index 00000000000..67ad240c8c7 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-list-metric-type/send-in-pings.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringListMetricType](index.md) / [sendInPings](./send-in-pings.md) + +# sendInPings + +`val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringListMetricType.kt#L26) + +Overrides [CommonMetricData.sendInPings](../-common-metric-data/send-in-pings.md) + diff --git a/docs/api/mozilla.components.service.glean/-string-list-metric-type/set.md b/docs/api/mozilla.components.service.glean/-string-list-metric-type/set.md new file mode 100644 index 00000000000..10e01666e19 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-list-metric-type/set.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringListMetricType](index.md) / [set](./set.md) + +# set + +`fun set(value: `[`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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringListMetricType.kt#L82) + +Sets a string list to one or more metric stores. + +### Parameters + +`value` - This is a user defined string list. The maximum length of each string in the + list is defined by [MAX_STRING_LENGTH](-m-a-x_-s-t-r-i-n-g_-l-e-n-g-t-h.md), while the maximum length of the list itself is + defined by [StringListsStorageEngine.MAX_LIST_LENGTH_VALUE](#). If a longer list is passed + into this function, then the additional values will be dropped from the list and the list, + up to the [StringListsStorageEngine.MAX_LIST_LENGTH_VALUE](#), will still be recorded. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-string-list-metric-type/test-get-value.md b/docs/api/mozilla.components.service.glean/-string-list-metric-type/test-get-value.md new file mode 100644 index 00000000000..9355380f219 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-list-metric-type/test-get-value.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringListMetricType](index.md) / [testGetValue](./test-get-value.md) + +# testGetValue + +`fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringListMetricType.kt#L128) + +Returns the stored value for testing purposes only + +### Parameters + +`pingName` - represents the name of the ping to retrieve the metric for. Defaults + to the either the first value in [defaultStorageDestinations](default-storage-destinations.md) or the first + value in [sendInPings](send-in-pings.md) + +### Exceptions + +`NullPointerException` - if no value is stored + +**Return** +value of the stored metric + diff --git a/docs/api/mozilla.components.service.glean/-string-list-metric-type/test-has-value.md b/docs/api/mozilla.components.service.glean/-string-list-metric-type/test-has-value.md new file mode 100644 index 00000000000..551743f74dd --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-list-metric-type/test-has-value.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringListMetricType](index.md) / [testHasValue](./test-has-value.md) + +# testHasValue + +`fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringListMetricType.kt#L114) + +Tests whether a value is stored for the metric for testing purposes only + +### Parameters + +`pingName` - represents the name of the ping to retrieve the metric for. Defaults + to the either the first value in [defaultStorageDestinations](default-storage-destinations.md) or the first + value in [sendInPings](send-in-pings.md) + +**Return** +true if metric value exists, otherwise false + diff --git a/docs/api/mozilla.components.service.glean/-string-metric-type/-init-.md b/docs/api/mozilla.components.service.glean/-string-metric-type/-init-.md new file mode 100644 index 00000000000..6ab954d326a --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-metric-type/-init-.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringMetricType](index.md) / [<init>](./-init-.md) + +# <init> + +`StringMetricType(disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, lifetime: `[`Lifetime`](../-lifetime/index.md)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>)` + +This implements the developer facing API for recording string metrics. + +Instances of this class type are automatically generated by the parsers at build time, +allowing developers to record values that were previously registered in the metrics.yaml file. + +The string API only exposes the [set](set.md) method, which takes care of validating the input +data and making sure that limits are enforced. + diff --git a/docs/api/mozilla.components.service.glean/-string-metric-type/category.md b/docs/api/mozilla.components.service.glean/-string-metric-type/category.md new file mode 100644 index 00000000000..e5bb1410234 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-metric-type/category.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringMetricType](index.md) / [category](./category.md) + +# category + +`val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringMetricType.kt#L23) + +Overrides [CommonMetricData.category](../-common-metric-data/category.md) + diff --git a/docs/api/mozilla.components.service.glean/-string-metric-type/default-storage-destinations.md b/docs/api/mozilla.components.service.glean/-string-metric-type/default-storage-destinations.md new file mode 100644 index 00000000000..ed8017764c6 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-metric-type/default-storage-destinations.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringMetricType](index.md) / [defaultStorageDestinations](./default-storage-destinations.md) + +# defaultStorageDestinations + +`val defaultStorageDestinations: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringMetricType.kt#L29) + +Overrides [CommonMetricData.defaultStorageDestinations](../-common-metric-data/default-storage-destinations.md) + +Defines the names of the storages the metric defaults to when +"default" is used as the destination storage. +Note that every metric type will need to override this. + diff --git a/docs/api/mozilla.components.service.glean/-string-metric-type/disabled.md b/docs/api/mozilla.components.service.glean/-string-metric-type/disabled.md new file mode 100644 index 00000000000..5dfd89b81d7 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-metric-type/disabled.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringMetricType](index.md) / [disabled](./disabled.md) + +# disabled + +`val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringMetricType.kt#L22) + +Overrides [CommonMetricData.disabled](../-common-metric-data/disabled.md) + diff --git a/docs/api/mozilla.components.service.glean/-string-metric-type/index.md b/docs/api/mozilla.components.service.glean/-string-metric-type/index.md new file mode 100644 index 00000000000..6b78454b2a3 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-metric-type/index.md @@ -0,0 +1,51 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringMetricType](./index.md) + +# StringMetricType + +`data class StringMetricType : `[`CommonMetricData`](../-common-metric-data/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringMetricType.kt#L21) + +This implements the developer facing API for recording string metrics. + +Instances of this class type are automatically generated by the parsers at build time, +allowing developers to record values that were previously registered in the metrics.yaml file. + +The string API only exposes the [set](set.md) method, which takes care of validating the input +data and making sure that limits are enforced. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `StringMetricType(disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, lifetime: `[`Lifetime`](../-lifetime/index.md)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>)`
This implements the developer facing API for recording string metrics. | + +### Properties + +| Name | Summary | +|---|---| +| [category](category.md) | `val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [defaultStorageDestinations](default-storage-destinations.md) | `val defaultStorageDestinations: `[`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)`>`
Defines the names of the storages the metric defaults to when "default" is used as the destination storage. Note that every metric type will need to override this. | +| [disabled](disabled.md) | `val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [lifetime](lifetime.md) | `val lifetime: `[`Lifetime`](../-lifetime/index.md) | +| [name](name.md) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [sendInPings](send-in-pings.md) | `val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [identifier](../-common-metric-data/identifier.md) | `open val identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [set](set.md) | `fun set(value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Set a string value. | +| [testGetValue](test-get-value.md) | `fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Returns the stored value for testing purposes only | +| [testHasValue](test-has-value.md) | `fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Tests whether a value is stored for the metric for testing purposes only | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getStorageNames](../-common-metric-data/get-storage-names.md) | `open fun getStorageNames(): `[`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)`>`
Get the list of storage names the metric will record to. This automatically expands [DEFAULT_STORAGE_NAME](#) to the list of default storages for the metric. | +| [shouldRecord](../-common-metric-data/should-record.md) | `open fun shouldRecord(logger: `[`Logger`](../../mozilla.components.support.base.log.logger/-logger/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | diff --git a/docs/api/mozilla.components.service.glean/-string-metric-type/lifetime.md b/docs/api/mozilla.components.service.glean/-string-metric-type/lifetime.md new file mode 100644 index 00000000000..945dd09838e --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-metric-type/lifetime.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringMetricType](index.md) / [lifetime](./lifetime.md) + +# lifetime + +`val lifetime: `[`Lifetime`](../-lifetime/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringMetricType.kt#L24) + +Overrides [CommonMetricData.lifetime](../-common-metric-data/lifetime.md) + diff --git a/docs/api/mozilla.components.service.glean/-string-metric-type/name.md b/docs/api/mozilla.components.service.glean/-string-metric-type/name.md new file mode 100644 index 00000000000..d03e0739e89 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-metric-type/name.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringMetricType](index.md) / [name](./name.md) + +# name + +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringMetricType.kt#L25) + +Overrides [CommonMetricData.name](../-common-metric-data/name.md) + diff --git a/docs/api/mozilla.components.service.glean/-string-metric-type/send-in-pings.md b/docs/api/mozilla.components.service.glean/-string-metric-type/send-in-pings.md new file mode 100644 index 00000000000..9aa2ff29683 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-metric-type/send-in-pings.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringMetricType](index.md) / [sendInPings](./send-in-pings.md) + +# sendInPings + +`val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringMetricType.kt#L26) + +Overrides [CommonMetricData.sendInPings](../-common-metric-data/send-in-pings.md) + diff --git a/docs/api/mozilla.components.service.glean/-string-metric-type/set.md b/docs/api/mozilla.components.service.glean/-string-metric-type/set.md new file mode 100644 index 00000000000..d445f409558 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-metric-type/set.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringMetricType](index.md) / [set](./set.md) + +# set + +`fun set(value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringMetricType.kt#L44) + +Set a string value. + +### Parameters + +`value` - This is a user defined string value. If the length of the string +exceeds [MAX_LENGTH_VALUE](#) characters, it will be truncated. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-string-metric-type/test-get-value.md b/docs/api/mozilla.components.service.glean/-string-metric-type/test-get-value.md new file mode 100644 index 00000000000..32ad66f9754 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-metric-type/test-get-value.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringMetricType](index.md) / [testGetValue](./test-get-value.md) + +# testGetValue + +`fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringMetricType.kt#L91) + +Returns the stored value for testing purposes only + +### Parameters + +`pingName` - represents the name of the ping to retrieve the metric for. Defaults + to the either the first value in [defaultStorageDestinations](default-storage-destinations.md) or the first + value in [sendInPings](send-in-pings.md) + +### Exceptions + +`NullPointerException` - if no value is stored + +**Return** +value of the stored metric + diff --git a/docs/api/mozilla.components.service.glean/-string-metric-type/test-has-value.md b/docs/api/mozilla.components.service.glean/-string-metric-type/test-has-value.md new file mode 100644 index 00000000000..c096563382f --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-string-metric-type/test-has-value.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [StringMetricType](index.md) / [testHasValue](./test-has-value.md) + +# testHasValue + +`fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/StringMetricType.kt#L77) + +Tests whether a value is stored for the metric for testing purposes only + +### Parameters + +`pingName` - represents the name of the ping to retrieve the metric for. Defaults + to the either the first value in [defaultStorageDestinations](default-storage-destinations.md) or the first + value in [sendInPings](send-in-pings.md) + +**Return** +true if metric value exists, otherwise false + diff --git a/docs/api/mozilla.components.service.glean/-time-unit/-day.md b/docs/api/mozilla.components.service.glean/-time-unit/-day.md new file mode 100644 index 00000000000..6f1ba9c75a4 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-time-unit/-day.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimeUnit](index.md) / [Day](./-day.md) + +# Day + +`Day` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimeUnit.kt#L18) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-time-unit/-hour.md b/docs/api/mozilla.components.service.glean/-time-unit/-hour.md new file mode 100644 index 00000000000..0833e8526a6 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-time-unit/-hour.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimeUnit](index.md) / [Hour](./-hour.md) + +# Hour + +`Hour` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimeUnit.kt#L17) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-time-unit/-microsecond.md b/docs/api/mozilla.components.service.glean/-time-unit/-microsecond.md new file mode 100644 index 00000000000..3d7f0f8a1b9 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-time-unit/-microsecond.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimeUnit](index.md) / [Microsecond](./-microsecond.md) + +# Microsecond + +`Microsecond` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimeUnit.kt#L13) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-time-unit/-millisecond.md b/docs/api/mozilla.components.service.glean/-time-unit/-millisecond.md new file mode 100644 index 00000000000..f8ebc94ce27 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-time-unit/-millisecond.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimeUnit](index.md) / [Millisecond](./-millisecond.md) + +# Millisecond + +`Millisecond` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimeUnit.kt#L14) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-time-unit/-minute.md b/docs/api/mozilla.components.service.glean/-time-unit/-minute.md new file mode 100644 index 00000000000..e4ab90a5322 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-time-unit/-minute.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimeUnit](index.md) / [Minute](./-minute.md) + +# Minute + +`Minute` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimeUnit.kt#L16) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-time-unit/-nanosecond.md b/docs/api/mozilla.components.service.glean/-time-unit/-nanosecond.md new file mode 100644 index 00000000000..02277b46a90 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-time-unit/-nanosecond.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimeUnit](index.md) / [Nanosecond](./-nanosecond.md) + +# Nanosecond + +`Nanosecond` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimeUnit.kt#L12) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-time-unit/-second.md b/docs/api/mozilla.components.service.glean/-time-unit/-second.md new file mode 100644 index 00000000000..29fc072989e --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-time-unit/-second.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimeUnit](index.md) / [Second](./-second.md) + +# Second + +`Second` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimeUnit.kt#L15) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-time-unit/index.md b/docs/api/mozilla.components.service.glean/-time-unit/index.md new file mode 100644 index 00000000000..5b8654598d7 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-time-unit/index.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimeUnit](./index.md) + +# TimeUnit + +`enum class TimeUnit` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimeUnit.kt#L11) + +Enumeration of different resolutions supported by +the Timespan metric type. + +### Enum Values + +| Name | Summary | +|---|---| +| [Nanosecond](-nanosecond.md) | | +| [Microsecond](-microsecond.md) | | +| [Millisecond](-millisecond.md) | | +| [Second](-second.md) | | +| [Minute](-minute.md) | | +| [Hour](-hour.md) | | +| [Day](-day.md) | | diff --git a/docs/api/mozilla.components.service.glean/-timespan-metric-type/-init-.md b/docs/api/mozilla.components.service.glean/-timespan-metric-type/-init-.md new file mode 100644 index 00000000000..239261421b5 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-timespan-metric-type/-init-.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimespanMetricType](index.md) / [<init>](./-init-.md) + +# <init> + +`TimespanMetricType(disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, lifetime: `[`Lifetime`](../-lifetime/index.md)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>, timeUnit: `[`TimeUnit`](../-time-unit/index.md)`)` + +This implements the developer facing API for recording timespans. + +Instances of this class type are automatically generated by the parsers at build time, +allowing developers to record values that were previously registered in the metrics.yaml file. + +The timespans API exposes the [start](start.md), [stopAndSum](stop-and-sum.md) and [cancel](cancel.md) methods. + diff --git a/docs/api/mozilla.components.service.glean/-timespan-metric-type/cancel.md b/docs/api/mozilla.components.service.glean/-timespan-metric-type/cancel.md new file mode 100644 index 00000000000..1577cf4f819 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-timespan-metric-type/cancel.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimespanMetricType](index.md) / [cancel](./cancel.md) + +# cancel + +`fun cancel(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimespanMetricType.kt#L60) + +Abort a previous [start](start.md) call. No error is recorded if no [start](start.md) was called. + diff --git a/docs/api/mozilla.components.service.glean/-timespan-metric-type/category.md b/docs/api/mozilla.components.service.glean/-timespan-metric-type/category.md new file mode 100644 index 00000000000..e1e13730246 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-timespan-metric-type/category.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimespanMetricType](index.md) / [category](./category.md) + +# category + +`val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimespanMetricType.kt#L21) + +Overrides [CommonMetricData.category](../-common-metric-data/category.md) + diff --git a/docs/api/mozilla.components.service.glean/-timespan-metric-type/default-storage-destinations.md b/docs/api/mozilla.components.service.glean/-timespan-metric-type/default-storage-destinations.md new file mode 100644 index 00000000000..ff7259bed0e --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-timespan-metric-type/default-storage-destinations.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimespanMetricType](index.md) / [defaultStorageDestinations](./default-storage-destinations.md) + +# defaultStorageDestinations + +`val defaultStorageDestinations: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimespanMetricType.kt#L28) + +Overrides [CommonMetricData.defaultStorageDestinations](../-common-metric-data/default-storage-destinations.md) + +Defines the names of the storages the metric defaults to when +"default" is used as the destination storage. +Note that every metric type will need to override this. + diff --git a/docs/api/mozilla.components.service.glean/-timespan-metric-type/disabled.md b/docs/api/mozilla.components.service.glean/-timespan-metric-type/disabled.md new file mode 100644 index 00000000000..7eba9346a26 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-timespan-metric-type/disabled.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimespanMetricType](index.md) / [disabled](./disabled.md) + +# disabled + +`val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimespanMetricType.kt#L20) + +Overrides [CommonMetricData.disabled](../-common-metric-data/disabled.md) + diff --git a/docs/api/mozilla.components.service.glean/-timespan-metric-type/index.md b/docs/api/mozilla.components.service.glean/-timespan-metric-type/index.md new file mode 100644 index 00000000000..db7cea06087 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-timespan-metric-type/index.md @@ -0,0 +1,53 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimespanMetricType](./index.md) + +# TimespanMetricType + +`data class TimespanMetricType : `[`CommonMetricData`](../-common-metric-data/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimespanMetricType.kt#L19) + +This implements the developer facing API for recording timespans. + +Instances of this class type are automatically generated by the parsers at build time, +allowing developers to record values that were previously registered in the metrics.yaml file. + +The timespans API exposes the [start](start.md), [stopAndSum](stop-and-sum.md) and [cancel](cancel.md) methods. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TimespanMetricType(disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, lifetime: `[`Lifetime`](../-lifetime/index.md)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>, timeUnit: `[`TimeUnit`](../-time-unit/index.md)`)`
This implements the developer facing API for recording timespans. | + +### Properties + +| Name | Summary | +|---|---| +| [category](category.md) | `val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [defaultStorageDestinations](default-storage-destinations.md) | `val defaultStorageDestinations: `[`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)`>`
Defines the names of the storages the metric defaults to when "default" is used as the destination storage. Note that every metric type will need to override this. | +| [disabled](disabled.md) | `val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [lifetime](lifetime.md) | `val lifetime: `[`Lifetime`](../-lifetime/index.md) | +| [name](name.md) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [sendInPings](send-in-pings.md) | `val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` | +| [timeUnit](time-unit.md) | `val timeUnit: `[`TimeUnit`](../-time-unit/index.md) | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [identifier](../-common-metric-data/identifier.md) | `open val identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [cancel](cancel.md) | `fun cancel(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Abort a previous [start](start.md) call. No error is recorded if no [start](start.md) was called. | +| [start](start.md) | `fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Start tracking time for the provided metric. This records an error if it’s already tracking time (i.e. start was already called with no corresponding [stopAndSum](stop-and-sum.md)): in that case the original start time will be preserved. | +| [stopAndSum](stop-and-sum.md) | `fun stopAndSum(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stop tracking time for the provided metric. Add the elapsed time to the time currently stored in the metric. This will record an error if no [start](start.md) was called. | +| [testGetValue](test-get-value.md) | `fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Returns the stored value for testing purposes only | +| [testHasValue](test-has-value.md) | `fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Tests whether a value is stored for the metric for testing purposes only | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getStorageNames](../-common-metric-data/get-storage-names.md) | `open fun getStorageNames(): `[`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)`>`
Get the list of storage names the metric will record to. This automatically expands [DEFAULT_STORAGE_NAME](#) to the list of default storages for the metric. | +| [shouldRecord](../-common-metric-data/should-record.md) | `open fun shouldRecord(logger: `[`Logger`](../../mozilla.components.support.base.log.logger/-logger/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | diff --git a/docs/api/mozilla.components.service.glean/-timespan-metric-type/lifetime.md b/docs/api/mozilla.components.service.glean/-timespan-metric-type/lifetime.md new file mode 100644 index 00000000000..453399740bf --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-timespan-metric-type/lifetime.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimespanMetricType](index.md) / [lifetime](./lifetime.md) + +# lifetime + +`val lifetime: `[`Lifetime`](../-lifetime/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimespanMetricType.kt#L22) + +Overrides [CommonMetricData.lifetime](../-common-metric-data/lifetime.md) + diff --git a/docs/api/mozilla.components.service.glean/-timespan-metric-type/name.md b/docs/api/mozilla.components.service.glean/-timespan-metric-type/name.md new file mode 100644 index 00000000000..729b751e512 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-timespan-metric-type/name.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimespanMetricType](index.md) / [name](./name.md) + +# name + +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimespanMetricType.kt#L23) + +Overrides [CommonMetricData.name](../-common-metric-data/name.md) + diff --git a/docs/api/mozilla.components.service.glean/-timespan-metric-type/send-in-pings.md b/docs/api/mozilla.components.service.glean/-timespan-metric-type/send-in-pings.md new file mode 100644 index 00000000000..6c15a8a46fe --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-timespan-metric-type/send-in-pings.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimespanMetricType](index.md) / [sendInPings](./send-in-pings.md) + +# sendInPings + +`val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimespanMetricType.kt#L24) + +Overrides [CommonMetricData.sendInPings](../-common-metric-data/send-in-pings.md) + diff --git a/docs/api/mozilla.components.service.glean/-timespan-metric-type/start.md b/docs/api/mozilla.components.service.glean/-timespan-metric-type/start.md new file mode 100644 index 00000000000..40a18dfd415 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-timespan-metric-type/start.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimespanMetricType](index.md) / [start](./start.md) + +# start + +`fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimespanMetricType.kt#L37) + +Start tracking time for the provided metric. This records an error if it’s +already tracking time (i.e. start was already called with no corresponding +[stopAndSum](stop-and-sum.md)): in that case the original start time will be preserved. + diff --git a/docs/api/mozilla.components.service.glean/-timespan-metric-type/stop-and-sum.md b/docs/api/mozilla.components.service.glean/-timespan-metric-type/stop-and-sum.md new file mode 100644 index 00000000000..36b46be7858 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-timespan-metric-type/stop-and-sum.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimespanMetricType](index.md) / [stopAndSum](./stop-and-sum.md) + +# stopAndSum + +`fun stopAndSum(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimespanMetricType.kt#L49) + +Stop tracking time for the provided metric. Add the elapsed time to the time currently +stored in the metric. This will record an error if no [start](start.md) was called. + diff --git a/docs/api/mozilla.components.service.glean/-timespan-metric-type/test-get-value.md b/docs/api/mozilla.components.service.glean/-timespan-metric-type/test-get-value.md new file mode 100644 index 00000000000..65ad2025a8c --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-timespan-metric-type/test-get-value.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimespanMetricType](index.md) / [testGetValue](./test-get-value.md) + +# testGetValue + +`fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimespanMetricType.kt#L91) + +Returns the stored value for testing purposes only + +### Parameters + +`pingName` - represents the name of the ping to retrieve the metric for. Defaults + to the either the first value in [defaultStorageDestinations](default-storage-destinations.md) or the first + value in [sendInPings](send-in-pings.md) + +### Exceptions + +`NullPointerException` - if no value is stored + +**Return** +value of the stored metric + diff --git a/docs/api/mozilla.components.service.glean/-timespan-metric-type/test-has-value.md b/docs/api/mozilla.components.service.glean/-timespan-metric-type/test-has-value.md new file mode 100644 index 00000000000..6678bb8e0b9 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-timespan-metric-type/test-has-value.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimespanMetricType](index.md) / [testHasValue](./test-has-value.md) + +# testHasValue + +`fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimespanMetricType.kt#L77) + +Tests whether a value is stored for the metric for testing purposes only + +### Parameters + +`pingName` - represents the name of the ping to retrieve the metric for. Defaults + to the either the first value in [defaultStorageDestinations](default-storage-destinations.md) or the first + value in [sendInPings](send-in-pings.md) + +**Return** +true if metric value exists, otherwise false + diff --git a/docs/api/mozilla.components.service.glean/-timespan-metric-type/time-unit.md b/docs/api/mozilla.components.service.glean/-timespan-metric-type/time-unit.md new file mode 100644 index 00000000000..05eb28c16dd --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-timespan-metric-type/time-unit.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [TimespanMetricType](index.md) / [timeUnit](./time-unit.md) + +# timeUnit + +`val timeUnit: `[`TimeUnit`](../-time-unit/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/TimespanMetricType.kt#L25) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-uuid-metric-type/-init-.md b/docs/api/mozilla.components.service.glean/-uuid-metric-type/-init-.md new file mode 100644 index 00000000000..fbd546cd70e --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-uuid-metric-type/-init-.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [UuidMetricType](index.md) / [<init>](./-init-.md) + +# <init> + +`UuidMetricType(disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, lifetime: `[`Lifetime`](../-lifetime/index.md)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>)` + +This implements the developer facing API for recording uuids. + +Instances of this class type are automatically generated by the parsers at build time, +allowing developers to record values that were previously registered in the metrics.yaml file. + +The uuid API exposes the [generateAndSet](generate-and-set.md) and [set](set.md) methods. + diff --git a/docs/api/mozilla.components.service.glean/-uuid-metric-type/category.md b/docs/api/mozilla.components.service.glean/-uuid-metric-type/category.md new file mode 100644 index 00000000000..80be7541385 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-uuid-metric-type/category.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [UuidMetricType](index.md) / [category](./category.md) + +# category + +`val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/UuidMetricType.kt#L24) + +Overrides [CommonMetricData.category](../-common-metric-data/category.md) + diff --git a/docs/api/mozilla.components.service.glean/-uuid-metric-type/default-storage-destinations.md b/docs/api/mozilla.components.service.glean/-uuid-metric-type/default-storage-destinations.md new file mode 100644 index 00000000000..6bfc7d3bf80 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-uuid-metric-type/default-storage-destinations.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [UuidMetricType](index.md) / [defaultStorageDestinations](./default-storage-destinations.md) + +# defaultStorageDestinations + +`val defaultStorageDestinations: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/UuidMetricType.kt#L30) + +Overrides [CommonMetricData.defaultStorageDestinations](../-common-metric-data/default-storage-destinations.md) + +Defines the names of the storages the metric defaults to when +"default" is used as the destination storage. +Note that every metric type will need to override this. + diff --git a/docs/api/mozilla.components.service.glean/-uuid-metric-type/disabled.md b/docs/api/mozilla.components.service.glean/-uuid-metric-type/disabled.md new file mode 100644 index 00000000000..521f304394a --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-uuid-metric-type/disabled.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [UuidMetricType](index.md) / [disabled](./disabled.md) + +# disabled + +`val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/UuidMetricType.kt#L23) + +Overrides [CommonMetricData.disabled](../-common-metric-data/disabled.md) + diff --git a/docs/api/mozilla.components.service.glean/-uuid-metric-type/generate-and-set.md b/docs/api/mozilla.components.service.glean/-uuid-metric-type/generate-and-set.md new file mode 100644 index 00000000000..6df0046c545 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-uuid-metric-type/generate-and-set.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [UuidMetricType](index.md) / [generateAndSet](./generate-and-set.md) + +# generateAndSet + +`fun generateAndSet(): `[`UUID`](https://developer.android.com/reference/java/util/UUID.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/UuidMetricType.kt#L39) + +Generate a new UUID value and set it in the metric store. + +**Return** +a [UUID](https://developer.android.com/reference/java/util/UUID.html) or [null](#) if we're not allowed to record. + diff --git a/docs/api/mozilla.components.service.glean/-uuid-metric-type/index.md b/docs/api/mozilla.components.service.glean/-uuid-metric-type/index.md new file mode 100644 index 00000000000..920dbd6d922 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-uuid-metric-type/index.md @@ -0,0 +1,51 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [UuidMetricType](./index.md) + +# UuidMetricType + +`data class UuidMetricType : `[`CommonMetricData`](../-common-metric-data/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/UuidMetricType.kt#L22) + +This implements the developer facing API for recording uuids. + +Instances of this class type are automatically generated by the parsers at build time, +allowing developers to record values that were previously registered in the metrics.yaml file. + +The uuid API exposes the [generateAndSet](generate-and-set.md) and [set](set.md) methods. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `UuidMetricType(disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`, category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, lifetime: `[`Lifetime`](../-lifetime/index.md)`, name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>)`
This implements the developer facing API for recording uuids. | + +### Properties + +| Name | Summary | +|---|---| +| [category](category.md) | `val category: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [defaultStorageDestinations](default-storage-destinations.md) | `val defaultStorageDestinations: `[`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)`>`
Defines the names of the storages the metric defaults to when "default" is used as the destination storage. Note that every metric type will need to override this. | +| [disabled](disabled.md) | `val disabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [lifetime](lifetime.md) | `val lifetime: `[`Lifetime`](../-lifetime/index.md) | +| [name](name.md) | `val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [sendInPings](send-in-pings.md) | `val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` | + +### Inherited Properties + +| Name | Summary | +|---|---| +| [identifier](../-common-metric-data/identifier.md) | `open val identifier: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [generateAndSet](generate-and-set.md) | `fun generateAndSet(): `[`UUID`](https://developer.android.com/reference/java/util/UUID.html)`?`
Generate a new UUID value and set it in the metric store. | +| [set](set.md) | `fun set(value: `[`UUID`](https://developer.android.com/reference/java/util/UUID.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Explicitly set an existing UUID value | +| [testGetValue](test-get-value.md) | `fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`UUID`](https://developer.android.com/reference/java/util/UUID.html)
Returns the stored value for testing purposes only | +| [testHasValue](test-has-value.md) | `fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Tests whether a value is stored for the metric for testing purposes only | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getStorageNames](../-common-metric-data/get-storage-names.md) | `open fun getStorageNames(): `[`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)`>`
Get the list of storage names the metric will record to. This automatically expands [DEFAULT_STORAGE_NAME](#) to the list of default storages for the metric. | +| [shouldRecord](../-common-metric-data/should-record.md) | `open fun shouldRecord(logger: `[`Logger`](../../mozilla.components.support.base.log.logger/-logger/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | diff --git a/docs/api/mozilla.components.service.glean/-uuid-metric-type/lifetime.md b/docs/api/mozilla.components.service.glean/-uuid-metric-type/lifetime.md new file mode 100644 index 00000000000..941ac13c78a --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-uuid-metric-type/lifetime.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [UuidMetricType](index.md) / [lifetime](./lifetime.md) + +# lifetime + +`val lifetime: `[`Lifetime`](../-lifetime/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/UuidMetricType.kt#L25) + +Overrides [CommonMetricData.lifetime](../-common-metric-data/lifetime.md) + diff --git a/docs/api/mozilla.components.service.glean/-uuid-metric-type/name.md b/docs/api/mozilla.components.service.glean/-uuid-metric-type/name.md new file mode 100644 index 00000000000..afb89cd5aaa --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-uuid-metric-type/name.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [UuidMetricType](index.md) / [name](./name.md) + +# name + +`val name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/UuidMetricType.kt#L26) + +Overrides [CommonMetricData.name](../-common-metric-data/name.md) + diff --git a/docs/api/mozilla.components.service.glean/-uuid-metric-type/send-in-pings.md b/docs/api/mozilla.components.service.glean/-uuid-metric-type/send-in-pings.md new file mode 100644 index 00000000000..0f6f5af46f4 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-uuid-metric-type/send-in-pings.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [UuidMetricType](index.md) / [sendInPings](./send-in-pings.md) + +# sendInPings + +`val sendInPings: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/UuidMetricType.kt#L27) + +Overrides [CommonMetricData.sendInPings](../-common-metric-data/send-in-pings.md) + diff --git a/docs/api/mozilla.components.service.glean/-uuid-metric-type/set.md b/docs/api/mozilla.components.service.glean/-uuid-metric-type/set.md new file mode 100644 index 00000000000..5e2d5652438 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-uuid-metric-type/set.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [UuidMetricType](index.md) / [set](./set.md) + +# set + +`fun set(value: `[`UUID`](https://developer.android.com/reference/java/util/UUID.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/UuidMetricType.kt#L57) + +Explicitly set an existing UUID value + +### Parameters + +`value` - a valid [UUID](https://developer.android.com/reference/java/util/UUID.html) to set the metric to \ No newline at end of file diff --git a/docs/api/mozilla.components.service.glean/-uuid-metric-type/test-get-value.md b/docs/api/mozilla.components.service.glean/-uuid-metric-type/test-get-value.md new file mode 100644 index 00000000000..61a4caace38 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-uuid-metric-type/test-get-value.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [UuidMetricType](index.md) / [testGetValue](./test-get-value.md) + +# testGetValue + +`fun testGetValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`UUID`](https://developer.android.com/reference/java/util/UUID.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/UuidMetricType.kt#L97) + +Returns the stored value for testing purposes only + +### Parameters + +`pingName` - represents the name of the ping to retrieve the metric for. Defaults + to the either the first value in [defaultStorageDestinations](default-storage-destinations.md) or the first + value in [sendInPings](send-in-pings.md) + +### Exceptions + +`NullPointerException` - if no value is stored + +**Return** +value of the stored metric + diff --git a/docs/api/mozilla.components.service.glean/-uuid-metric-type/test-has-value.md b/docs/api/mozilla.components.service.glean/-uuid-metric-type/test-has-value.md new file mode 100644 index 00000000000..bc624afb4b8 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/-uuid-metric-type/test-has-value.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.service.glean](../index.md) / [UuidMetricType](index.md) / [testHasValue](./test-has-value.md) + +# testHasValue + +`fun testHasValue(pingName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getStorageNames().first()): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/src/main/java/mozilla/components/service/glean/UuidMetricType.kt#L82) + +Tests whether a value is stored for the metric for testing purposes only + +### Parameters + +`pingName` - represents the name of the ping to retrieve the metric for. Defaults + to the either the first value in [defaultStorageDestinations](default-storage-destinations.md) or the first + value in [sendInPings](send-in-pings.md) + +**Return** +true if metric value exists, otherwise false + diff --git a/docs/api/mozilla.components.service.glean/index.md b/docs/api/mozilla.components.service.glean/index.md new file mode 100644 index 00000000000..d9b202839b8 --- /dev/null +++ b/docs/api/mozilla.components.service.glean/index.md @@ -0,0 +1,20 @@ +[android-components](../index.md) / [mozilla.components.service.glean](./index.md) + +## Package mozilla.components.service.glean + +### Types + +| Name | Summary | +|---|---| +| [BooleanMetricType](-boolean-metric-type/index.md) | `data class BooleanMetricType : `[`CommonMetricData`](-common-metric-data/index.md)
This implements the developer facing API for recording boolean metrics. | +| [CommonMetricData](-common-metric-data/index.md) | `interface CommonMetricData`
This defines the common set of data shared across all the different metric types. | +| [CounterMetricType](-counter-metric-type/index.md) | `data class CounterMetricType : `[`CommonMetricData`](-common-metric-data/index.md)
This implements the developer facing API for recording counter metrics. | +| [EventMetricType](-event-metric-type/index.md) | `data class EventMetricType : `[`CommonMetricData`](-common-metric-data/index.md)
This implements the developer facing API for recording events. | +| [Glean](-glean/index.md) | `object Glean : `[`GleanInternalAPI`](-glean-internal-a-p-i/index.md) | +| [GleanInternalAPI](-glean-internal-a-p-i/index.md) | `open class GleanInternalAPI` | +| [Lifetime](-lifetime/index.md) | `enum class Lifetime`
Enumeration of different metric lifetimes. | +| [StringListMetricType](-string-list-metric-type/index.md) | `data class StringListMetricType : `[`CommonMetricData`](-common-metric-data/index.md)
This implements the developer facing API for recording string list metrics. | +| [StringMetricType](-string-metric-type/index.md) | `data class StringMetricType : `[`CommonMetricData`](-common-metric-data/index.md)
This implements the developer facing API for recording string metrics. | +| [TimeUnit](-time-unit/index.md) | `enum class TimeUnit`
Enumeration of different resolutions supported by the Timespan metric type. | +| [TimespanMetricType](-timespan-metric-type/index.md) | `data class TimespanMetricType : `[`CommonMetricData`](-common-metric-data/index.md)
This implements the developer facing API for recording timespans. | +| [UuidMetricType](-uuid-metric-type/index.md) | `data class UuidMetricType : `[`CommonMetricData`](-common-metric-data/index.md)
This implements the developer facing API for recording uuids. | diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/-init-.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/-init-.md new file mode 100644 index 00000000000..9baee59cdec --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [<init>](./-init-.md) + +# <init> + +`AsyncLoginsStorageAdapter(wrapped: `[`T`](index.md#T)`)` + +A helper class to wrap a synchronous [LoginsStorage](#) implementation and make it asynchronous. + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/add.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/add.md new file mode 100644 index 00000000000..f8f14ceadba --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/add.md @@ -0,0 +1,35 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [add](./add.md) + +# add + +`open fun add(login: `[`ServerPassword`](../-server-password.md)`): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L332) + +Overrides [AsyncLoginsStorage.add](../-async-logins-storage/add.md) + +Inserts the provided login into the database, returning it's id. + +This function ignores values in metadata fields (`timesUsed`, +`timeCreated`, `timeLastUsed`, and `timePasswordChanged`). + +If login has an empty id field, then a GUID will be +generated automatically. The format of generated guids +are left up to the implementation of LoginsStorage (in +practice the [DatabaseLoginsStorage](#) generates 12-character +base64url (RFC 4648) encoded strings, and [MemoryLoginsStorage](#) +generates strings using [java.util.UUID.toString](https://developer.android.com/reference/java/util/UUID.html#toString())) + +This will return an error result if a GUID is provided but +collides with an existing record, or if the provided record +is invalid (missing password, hostname, or doesn't have exactly +one of formSubmitURL and httpRealm). + +**RejectsWith** +[IdCollisionException](../-id-collision-exception.md) if a nonempty id is provided, and + +**RejectsWith** +[InvalidRecordException](../-invalid-record-exception.md) if the record is invalid. + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/close.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/close.md new file mode 100644 index 00000000000..cd83ac12f99 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/close.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [close](./close.md) + +# close + +`open fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L340) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/delete.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/delete.md new file mode 100644 index 00000000000..609000e0213 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/delete.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [delete](./delete.md) + +# delete + +`open fun delete(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L316) + +Overrides [AsyncLoginsStorage.delete](../-async-logins-storage/delete.md) + +Deletes the password with the given ID. + +Resolves to true if the deletion did anything. + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/ensure-locked.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/ensure-locked.md new file mode 100644 index 00000000000..420d4ac923d --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/ensure-locked.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [ensureLocked](./ensure-locked.md) + +# ensureLocked + +`open fun ensureLocked(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L286) + +Overrides [AsyncLoginsStorage.ensureLocked](../-async-logins-storage/ensure-locked.md) + +Equivalent to `lock()`, but does not throw in the case that +the database is already unlocked. Never rejects. + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/ensure-unlocked.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/ensure-unlocked.md new file mode 100644 index 00000000000..e58a4000424 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/ensure-unlocked.md @@ -0,0 +1,22 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [ensureUnlocked](./ensure-unlocked.md) + +# ensureUnlocked + +`open fun ensureUnlocked(encryptionKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L290) + +Overrides [AsyncLoginsStorage.ensureUnlocked](../-async-logins-storage/ensure-unlocked.md) + + +`open fun ensureUnlocked(encryptionKey: `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L294) + +Overrides [AsyncLoginsStorage.ensureUnlocked](../-async-logins-storage/ensure-unlocked.md) + +Equivalent to `unlock(encryptionKey)`, but does not throw in the case +that the database is already unlocked. + +**RejectsWith** +[InvalidKeyException](../-invalid-key-exception.md) if the encryption key is wrong, or the db is corrupt + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if there was some other error opening the database + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/for-database.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/for-database.md new file mode 100644 index 00000000000..2d975a60c68 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/for-database.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [forDatabase](./for-database.md) + +# forDatabase + +`fun forDatabase(dbPath: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`AsyncLoginsStorageAdapter`](index.md)`` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L349) + +Creates an [AsyncLoginsStorage](../-async-logins-storage/index.md) that is backed by a [DatabaseLoginsStorage](#). + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/get.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/get.md new file mode 100644 index 00000000000..31fc0ea7524 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/get.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [get](./get.md) + +# get + +`open fun get(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`ServerPassword`](../-server-password.md)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L320) + +Overrides [AsyncLoginsStorage.get](../-async-logins-storage/get.md) + +Fetches a password from the underlying storage layer by ID. + +Resolves to `null` if the record does not exist. + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/in-memory.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/in-memory.md new file mode 100644 index 00000000000..18ef7c0fe62 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/in-memory.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [inMemory](./in-memory.md) + +# inMemory + +`fun inMemory(items: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`ServerPassword`](../-server-password.md)`>): `[`AsyncLoginsStorageAdapter`](index.md)`` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L356) + +Creates an [AsyncLoginsStorage](../-async-logins-storage/index.md) that is backed by a [MemoryLoginsStorage](#). + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/index.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/index.md new file mode 100644 index 00000000000..44eae189eb5 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/index.md @@ -0,0 +1,40 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](./index.md) + +# AsyncLoginsStorageAdapter + +`open class AsyncLoginsStorageAdapter : `[`AsyncLoginsStorage`](../-async-logins-storage/index.md)`, `[`AutoCloseable`](https://developer.android.com/reference/java/lang/AutoCloseable.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L270) + +A helper class to wrap a synchronous [LoginsStorage](#) implementation and make it asynchronous. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AsyncLoginsStorageAdapter(wrapped: `[`T`](index.md#T)`)`
A helper class to wrap a synchronous [LoginsStorage](#) implementation and make it asynchronous. | + +### Functions + +| Name | Summary | +|---|---| +| [add](add.md) | `open fun add(login: `[`ServerPassword`](../-server-password.md)`): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>`
Inserts the provided login into the database, returning it's id. | +| [close](close.md) | `open fun close(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [delete](delete.md) | `open fun delete(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>`
Deletes the password with the given ID. | +| [ensureLocked](ensure-locked.md) | `open fun ensureLocked(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Equivalent to `lock()`, but does not throw in the case that the database is already unlocked. Never rejects. | +| [ensureUnlocked](ensure-unlocked.md) | `open fun ensureUnlocked(encryptionKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
`open fun ensureUnlocked(encryptionKey: `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Equivalent to `unlock(encryptionKey)`, but does not throw in the case that the database is already unlocked. | +| [get](get.md) | `open fun get(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`ServerPassword`](../-server-password.md)`?>`
Fetches a password from the underlying storage layer by ID. | +| [isLocked](is-locked.md) | `open fun isLocked(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns `true` if the storage is locked, false otherwise. | +| [list](list.md) | `open fun list(): Deferred<`[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`ServerPassword`](../-server-password.md)`>>`
Fetches the full list of passwords from the underlying storage layer. | +| [lock](lock.md) | `open fun lock(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Locks the logins storage. | +| [sync](sync.md) | `open fun sync(syncInfo: `[`SyncUnlockInfo`](../-sync-unlock-info.md)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Synchronizes the logins storage layer with a remote layer. | +| [touch](touch.md) | `open fun touch(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Marks the login with the given ID as `in-use`. | +| [unlock](unlock.md) | `open fun unlock(encryptionKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Unlocks the logins storage using the provided key.`open fun unlock(encryptionKey: `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Unlock (open) the database, using a byte string as the key. This is equivalent to calling unlock() after hex-encoding the bytes (lower case hexadecimal characters are used). | +| [update](update.md) | `open fun update(login: `[`ServerPassword`](../-server-password.md)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Updates the fields in the provided record. | +| [wipe](wipe.md) | `open fun wipe(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Delete all login records. These deletions will be synced to the server on the next call to sync. | +| [wipeLocal](wipe-local.md) | `open fun wipeLocal(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Clear out all local state, bringing us back to the state before the first write (or sync). | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [forDatabase](for-database.md) | `fun forDatabase(dbPath: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`AsyncLoginsStorageAdapter`](./index.md)``
Creates an [AsyncLoginsStorage](../-async-logins-storage/index.md) that is backed by a [DatabaseLoginsStorage](#). | +| [inMemory](in-memory.md) | `fun inMemory(items: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`ServerPassword`](../-server-password.md)`>): `[`AsyncLoginsStorageAdapter`](./index.md)``
Creates an [AsyncLoginsStorage](../-async-logins-storage/index.md) that is backed by a [MemoryLoginsStorage](#). | diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/is-locked.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/is-locked.md new file mode 100644 index 00000000000..69db81e1e49 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/is-locked.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [isLocked](./is-locked.md) + +# isLocked + +`open fun isLocked(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L302) + +Overrides [AsyncLoginsStorage.isLocked](../-async-logins-storage/is-locked.md) + +Returns `true` if the storage is locked, false otherwise. + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/list.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/list.md new file mode 100644 index 00000000000..95354450724 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/list.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [list](./list.md) + +# list + +`open fun list(): Deferred<`[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`ServerPassword`](../-server-password.md)`>>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L328) + +Overrides [AsyncLoginsStorage.list](../-async-logins-storage/list.md) + +Fetches the full list of passwords from the underlying storage layer. + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/lock.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/lock.md new file mode 100644 index 00000000000..7a4b350fd4a --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/lock.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [lock](./lock.md) + +# lock + +`open fun lock(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L274) + +Overrides [AsyncLoginsStorage.lock](../-async-logins-storage/lock.md) + +Locks the logins storage. + +**RejectsWith** +[MismatchedLockException](../-mismatched-lock-exception.md) if we're already locked + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/sync.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/sync.md new file mode 100644 index 00000000000..0e50af09085 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/sync.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [sync](./sync.md) + +# sync + +`open fun sync(syncInfo: `[`SyncUnlockInfo`](../-sync-unlock-info.md)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L306) + +Overrides [AsyncLoginsStorage.sync](../-async-logins-storage/sync.md) + +Synchronizes the logins storage layer with a remote layer. + +**RejectsWith** +[SyncAuthInvalidException](../-sync-auth-invalid-exception.md) if authentication needs to be refreshed + +**RejectsWith** +[RequestFailedException](../-request-failed-exception.md) if there was a network error during connection. + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/touch.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/touch.md new file mode 100644 index 00000000000..7b7fe90cb7e --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/touch.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [touch](./touch.md) + +# touch + +`open fun touch(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L324) + +Overrides [AsyncLoginsStorage.touch](../-async-logins-storage/touch.md) + +Marks the login with the given ID as `in-use`. + +**RejectsWith** +[NoSuchRecordException](../-no-such-record-exception.md) if the login does not exist. + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/unlock.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/unlock.md new file mode 100644 index 00000000000..f122e9b62c8 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/unlock.md @@ -0,0 +1,38 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [unlock](./unlock.md) + +# unlock + +`open fun unlock(encryptionKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L278) + +Overrides [AsyncLoginsStorage.unlock](../-async-logins-storage/unlock.md) + +Unlocks the logins storage using the provided key. + +**RejectsWith** +[InvalidKeyException](../-invalid-key-exception.md) if the encryption key is wrong, or the db is corrupt + +**RejectsWith** +[MismatchedLockException](../-mismatched-lock-exception.md) if we're already unlocked + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + +`open fun unlock(encryptionKey: `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L282) + +Overrides [AsyncLoginsStorage.unlock](../-async-logins-storage/unlock.md) + +Unlock (open) the database, using a byte string as the key. +This is equivalent to calling unlock() after hex-encoding the bytes (lower +case hexadecimal characters are used). + +**RejectsWith** +[InvalidKeyException](../-invalid-key-exception.md) if the encryption key is wrong, or the db is corrupt + +**RejectsWith** +[MismatchedLockException](../-mismatched-lock-exception.md) if the database is already unlocked + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/update.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/update.md new file mode 100644 index 00000000000..c437f18c80d --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/update.md @@ -0,0 +1,29 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [update](./update.md) + +# update + +`open fun update(login: `[`ServerPassword`](../-server-password.md)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L336) + +Overrides [AsyncLoginsStorage.update](../-async-logins-storage/update.md) + +Updates the fields in the provided record. + +This will return an error if `login.id` does not refer to +a record that exists in the database, or if the provided record +is invalid (missing password, hostname, or doesn't have exactly +one of formSubmitURL and httpRealm). + +Like `add`, this function will ignore values in metadata +fields (`timesUsed`, `timeCreated`, `timeLastUsed`, and +`timePasswordChanged`). + +**RejectsWith** +[NoSuchRecordException](../-no-such-record-exception.md) if the login does not exist. + +**RejectsWith** +[InvalidRecordException](../-invalid-record-exception.md) if the update would create an invalid record. + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/wipe-local.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/wipe-local.md new file mode 100644 index 00000000000..4bc4ef22e90 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/wipe-local.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [wipeLocal](./wipe-local.md) + +# wipeLocal + +`open fun wipeLocal(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L298) + +Overrides [AsyncLoginsStorage.wipeLocal](../-async-logins-storage/wipe-local.md) + +Clear out all local state, bringing us back to the state before the first write (or sync). + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/wipe.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/wipe.md new file mode 100644 index 00000000000..6e78765c813 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage-adapter/wipe.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorageAdapter](index.md) / [wipe](./wipe.md) + +# wipe + +`open fun wipe(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L312) + +Overrides [AsyncLoginsStorage.wipe](../-async-logins-storage/wipe.md) + +Delete all login records. These deletions will be synced to the server on the next call to sync. + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/add.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/add.md new file mode 100644 index 00000000000..f51fe3b5c6b --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/add.md @@ -0,0 +1,33 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorage](index.md) / [add](./add.md) + +# add + +`abstract fun add(login: `[`ServerPassword`](../-server-password.md)`): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L220) + +Inserts the provided login into the database, returning it's id. + +This function ignores values in metadata fields (`timesUsed`, +`timeCreated`, `timeLastUsed`, and `timePasswordChanged`). + +If login has an empty id field, then a GUID will be +generated automatically. The format of generated guids +are left up to the implementation of LoginsStorage (in +practice the [DatabaseLoginsStorage](#) generates 12-character +base64url (RFC 4648) encoded strings, and [MemoryLoginsStorage](#) +generates strings using [java.util.UUID.toString](https://developer.android.com/reference/java/util/UUID.html#toString())) + +This will return an error result if a GUID is provided but +collides with an existing record, or if the provided record +is invalid (missing password, hostname, or doesn't have exactly +one of formSubmitURL and httpRealm). + +**RejectsWith** +[IdCollisionException](../-id-collision-exception.md) if a nonempty id is provided, and + +**RejectsWith** +[InvalidRecordException](../-invalid-record-exception.md) if the record is invalid. + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/delete.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/delete.md new file mode 100644 index 00000000000..63e1588a942 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/delete.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorage](index.md) / [delete](./delete.md) + +# delete + +`abstract fun delete(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L168) + +Deletes the password with the given ID. + +Resolves to true if the deletion did anything. + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/ensure-locked.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/ensure-locked.md new file mode 100644 index 00000000000..c9bf9640be4 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/ensure-locked.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorage](index.md) / [ensureLocked](./ensure-locked.md) + +# ensureLocked + +`abstract fun ensureLocked(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L263) + +Equivalent to `lock()`, but does not throw in the case that +the database is already unlocked. Never rejects. + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/ensure-unlocked.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/ensure-unlocked.md new file mode 100644 index 00000000000..0e64b60ca99 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/ensure-unlocked.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorage](index.md) / [ensureUnlocked](./ensure-unlocked.md) + +# ensureUnlocked + +`abstract fun ensureUnlocked(encryptionKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L248) +`abstract fun ensureUnlocked(encryptionKey: `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L257) + +Equivalent to `unlock(encryptionKey)`, but does not throw in the case +that the database is already unlocked. + +**RejectsWith** +[InvalidKeyException](../-invalid-key-exception.md) if the encryption key is wrong, or the db is corrupt + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if there was some other error opening the database + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/get.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/get.md new file mode 100644 index 00000000000..76135041872 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/get.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorage](index.md) / [get](./get.md) + +# get + +`abstract fun get(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`ServerPassword`](../-server-password.md)`?>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L178) + +Fetches a password from the underlying storage layer by ID. + +Resolves to `null` if the record does not exist. + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/index.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/index.md new file mode 100644 index 00000000000..2b0b39846ff --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/index.md @@ -0,0 +1,33 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorage](./index.md) + +# AsyncLoginsStorage + +`interface AsyncLoginsStorage : `[`AutoCloseable`](https://developer.android.com/reference/java/lang/AutoCloseable.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L103) + +An interface equivalent to the LoginsStorage interface, but where operations are +asynchronous. + +### Functions + +| Name | Summary | +|---|---| +| [add](add.md) | `abstract fun add(login: `[`ServerPassword`](../-server-password.md)`): Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>`
Inserts the provided login into the database, returning it's id. | +| [delete](delete.md) | `abstract fun delete(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>`
Deletes the password with the given ID. | +| [ensureLocked](ensure-locked.md) | `abstract fun ensureLocked(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Equivalent to `lock()`, but does not throw in the case that the database is already unlocked. Never rejects. | +| [ensureUnlocked](ensure-unlocked.md) | `abstract fun ensureUnlocked(encryptionKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
`abstract fun ensureUnlocked(encryptionKey: `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Equivalent to `unlock(encryptionKey)`, but does not throw in the case that the database is already unlocked. | +| [get](get.md) | `abstract fun get(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`ServerPassword`](../-server-password.md)`?>`
Fetches a password from the underlying storage layer by ID. | +| [isLocked](is-locked.md) | `abstract fun isLocked(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns `true` if the storage is locked, false otherwise. | +| [list](list.md) | `abstract fun list(): Deferred<`[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`ServerPassword`](../-server-password.md)`>>`
Fetches the full list of passwords from the underlying storage layer. | +| [lock](lock.md) | `abstract fun lock(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Locks the logins storage. | +| [sync](sync.md) | `abstract fun sync(syncInfo: `[`SyncUnlockInfo`](../-sync-unlock-info.md)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Synchronizes the logins storage layer with a remote layer. | +| [touch](touch.md) | `abstract fun touch(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Marks the login with the given ID as `in-use`. | +| [unlock](unlock.md) | `abstract fun unlock(encryptionKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Unlocks the logins storage using the provided key.`abstract fun unlock(encryptionKey: `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Unlock (open) the database, using a byte string as the key. This is equivalent to calling unlock() after hex-encoding the bytes (lower case hexadecimal characters are used). | +| [update](update.md) | `abstract fun update(login: `[`ServerPassword`](../-server-password.md)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Updates the fields in the provided record. | +| [wipe](wipe.md) | `abstract fun wipe(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Delete all login records. These deletions will be synced to the server on the next call to sync. | +| [wipeLocal](wipe-local.md) | `abstract fun wipeLocal(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
Clear out all local state, bringing us back to the state before the first write (or sync). | + +### Inheritors + +| Name | Summary | +|---|---| +| [AsyncLoginsStorageAdapter](../-async-logins-storage-adapter/index.md) | `open class AsyncLoginsStorageAdapter : `[`AsyncLoginsStorage`](./index.md)`, `[`AutoCloseable`](https://developer.android.com/reference/java/lang/AutoCloseable.html)
A helper class to wrap a synchronous [LoginsStorage](#) implementation and make it asynchronous. | diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/is-locked.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/is-locked.md new file mode 100644 index 00000000000..586ea08ffd5 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/is-locked.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorage](index.md) / [isLocked](./is-locked.md) + +# isLocked + +`abstract fun isLocked(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L132) + +Returns `true` if the storage is locked, false otherwise. + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/list.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/list.md new file mode 100644 index 00000000000..bc2708d2366 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/list.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorage](index.md) / [list](./list.md) + +# list + +`abstract fun list(): Deferred<`[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`ServerPassword`](../-server-password.md)`>>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L195) + +Fetches the full list of passwords from the underlying storage layer. + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/lock.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/lock.md new file mode 100644 index 00000000000..3e6b7de9ed5 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/lock.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorage](index.md) / [lock](./lock.md) + +# lock + +`abstract fun lock(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L108) + +Locks the logins storage. + +**RejectsWith** +[MismatchedLockException](../-mismatched-lock-exception.md) if we're already locked + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/sync.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/sync.md new file mode 100644 index 00000000000..42610985cfb --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/sync.md @@ -0,0 +1,18 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorage](index.md) / [sync](./sync.md) + +# sync + +`abstract fun sync(syncInfo: `[`SyncUnlockInfo`](../-sync-unlock-info.md)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L142) + +Synchronizes the logins storage layer with a remote layer. + +**RejectsWith** +[SyncAuthInvalidException](../-sync-auth-invalid-exception.md) if authentication needs to be refreshed + +**RejectsWith** +[RequestFailedException](../-request-failed-exception.md) if there was a network error during connection. + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/touch.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/touch.md new file mode 100644 index 00000000000..d6c386a16d8 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/touch.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorage](index.md) / [touch](./touch.md) + +# touch + +`abstract fun touch(id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L187) + +Marks the login with the given ID as `in-use`. + +**RejectsWith** +[NoSuchRecordException](../-no-such-record-exception.md) if the login does not exist. + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/unlock.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/unlock.md new file mode 100644 index 00000000000..95d16a15e8c --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/unlock.md @@ -0,0 +1,34 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorage](index.md) / [unlock](./unlock.md) + +# unlock + +`abstract fun unlock(encryptionKey: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L117) + +Unlocks the logins storage using the provided key. + +**RejectsWith** +[InvalidKeyException](../-invalid-key-exception.md) if the encryption key is wrong, or the db is corrupt + +**RejectsWith** +[MismatchedLockException](../-mismatched-lock-exception.md) if we're already unlocked + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + +`abstract fun unlock(encryptionKey: `[`ByteArray`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L129) + +Unlock (open) the database, using a byte string as the key. +This is equivalent to calling unlock() after hex-encoding the bytes (lower +case hexadecimal characters are used). + +**RejectsWith** +[InvalidKeyException](../-invalid-key-exception.md) if the encryption key is wrong, or the db is corrupt + +**RejectsWith** +[MismatchedLockException](../-mismatched-lock-exception.md) if the database is already unlocked + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/update.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/update.md new file mode 100644 index 00000000000..7c9b816d2d6 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/update.md @@ -0,0 +1,27 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorage](index.md) / [update](./update.md) + +# update + +`abstract fun update(login: `[`ServerPassword`](../-server-password.md)`): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L239) + +Updates the fields in the provided record. + +This will return an error if `login.id` does not refer to +a record that exists in the database, or if the provided record +is invalid (missing password, hostname, or doesn't have exactly +one of formSubmitURL and httpRealm). + +Like `add`, this function will ignore values in metadata +fields (`timesUsed`, `timeCreated`, `timeLastUsed`, and +`timePasswordChanged`). + +**RejectsWith** +[NoSuchRecordException](../-no-such-record-exception.md) if the login does not exist. + +**RejectsWith** +[InvalidRecordException](../-invalid-record-exception.md) if the update would create an invalid record. + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/wipe-local.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/wipe-local.md new file mode 100644 index 00000000000..576f074bd28 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/wipe-local.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorage](index.md) / [wipeLocal](./wipe-local.md) + +# wipeLocal + +`abstract fun wipeLocal(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L158) + +Clear out all local state, bringing us back to the state before the first write (or sync). + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/wipe.md b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/wipe.md new file mode 100644 index 00000000000..ead00dbdee5 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-async-logins-storage/wipe.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [AsyncLoginsStorage](index.md) / [wipe](./wipe.md) + +# wipe + +`abstract fun wipe(): Deferred<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L150) + +Delete all login records. These deletions will be synced to the server on the next call to sync. + +**RejectsWith** +[LoginsStorageException](../-logins-storage-exception.md) if the storage is locked, and on unexpected + errors (IO failure, rust panics, etc) + diff --git a/docs/api/mozilla.components.service.sync.logins/-id-collision-exception.md b/docs/api/mozilla.components.service.sync.logins/-id-collision-exception.md new file mode 100644 index 00000000000..c405f21b621 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-id-collision-exception.md @@ -0,0 +1,12 @@ +[android-components](../index.md) / [mozilla.components.service.sync.logins](index.md) / [IdCollisionException](./-id-collision-exception.md) + +# IdCollisionException + +`typealias IdCollisionException = IdCollisionException` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L70) + +This is thrown if `add()` is given a record whose `id` is not blank, and +collides with a record already known to the storage instance. + +You can avoid ever worrying about this error by always providing blank +`id` property when inserting new records. + diff --git a/docs/api/mozilla.components.service.sync.logins/-invalid-key-exception.md b/docs/api/mozilla.components.service.sync.logins/-invalid-key-exception.md new file mode 100644 index 00000000000..bd2acd0baf7 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-invalid-key-exception.md @@ -0,0 +1,13 @@ +[android-components](../index.md) / [mozilla.components.service.sync.logins](index.md) / [InvalidKeyException](./-invalid-key-exception.md) + +# InvalidKeyException + +`typealias InvalidKeyException = InvalidKeyException` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L91) + +This error is emitted in two cases: + +1. An incorrect key is used to to open the login database +2. The file at the path specified is not a sqlite database. + +SQLCipher does not give any way to distinguish between these two cases. + diff --git a/docs/api/mozilla.components.service.sync.logins/-invalid-record-exception.md b/docs/api/mozilla.components.service.sync.logins/-invalid-record-exception.md new file mode 100644 index 00000000000..f67bdbe4a8b --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-invalid-record-exception.md @@ -0,0 +1,13 @@ +[android-components](../index.md) / [mozilla.components.service.sync.logins](index.md) / [InvalidRecordException](./-invalid-record-exception.md) + +# InvalidRecordException + +`typealias InvalidRecordException = InvalidRecordException` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L81) + +This is thrown on attempts to insert or update a record so that it +is no longer valid, where "invalid" is defined as such: + +* A record with a blank `password` is invalid. +* A record with a blank `hostname` is invalid. +* A record that doesn't have a `formSubmitURL` nor a `httpRealm` is invalid. +* A record that has both a `formSubmitURL` and a `httpRealm` is invalid. diff --git a/docs/api/mozilla.components.service.sync.logins/-logins-storage-exception.md b/docs/api/mozilla.components.service.sync.logins/-logins-storage-exception.md new file mode 100644 index 00000000000..9376ac40514 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-logins-storage-exception.md @@ -0,0 +1,15 @@ +[android-components](../index.md) / [mozilla.components.service.sync.logins](index.md) / [LoginsStorageException](./-logins-storage-exception.md) + +# LoginsStorageException + +`typealias LoginsStorageException = LoginsStorageException` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L42) + +The base class of all errors emitted by logins storage. + +Concrete instances of this class are thrown for operations which are +not expected to be handled in a meaningful way by the application. + +For example, caught Rust panics, SQL errors, failure to generate secure +random numbers, etc. are all examples of things which will result in a +concrete `LoginsStorageException`. + diff --git a/docs/api/mozilla.components.service.sync.logins/-mismatched-lock-exception.md b/docs/api/mozilla.components.service.sync.logins/-mismatched-lock-exception.md new file mode 100644 index 00000000000..ad2d7b7d46b --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-mismatched-lock-exception.md @@ -0,0 +1,8 @@ +[android-components](../index.md) / [mozilla.components.service.sync.logins](index.md) / [MismatchedLockException](./-mismatched-lock-exception.md) + +# MismatchedLockException + +`typealias MismatchedLockException = MismatchedLockException` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L55) + +This is thrown if `lock()`/`unlock()` pairs don't match up. + diff --git a/docs/api/mozilla.components.service.sync.logins/-no-such-record-exception.md b/docs/api/mozilla.components.service.sync.logins/-no-such-record-exception.md new file mode 100644 index 00000000000..25bc500a11b --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-no-such-record-exception.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.service.sync.logins](index.md) / [NoSuchRecordException](./-no-such-record-exception.md) + +# NoSuchRecordException + +`typealias NoSuchRecordException = NoSuchRecordException` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L61) + +This is thrown if `update()` is performed with a record whose ID +does not exist. + diff --git a/docs/api/mozilla.components.service.sync.logins/-request-failed-exception.md b/docs/api/mozilla.components.service.sync.logins/-request-failed-exception.md new file mode 100644 index 00000000000..fdd7250c5a2 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-request-failed-exception.md @@ -0,0 +1,8 @@ +[android-components](../index.md) / [mozilla.components.service.sync.logins](index.md) / [RequestFailedException](./-request-failed-exception.md) + +# RequestFailedException + +`typealias RequestFailedException = RequestFailedException` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L96) + +This error is emitted if a request to a sync server failed. + diff --git a/docs/api/mozilla.components.service.sync.logins/-server-password.md b/docs/api/mozilla.components.service.sync.logins/-server-password.md new file mode 100644 index 00000000000..a835e6b4978 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-server-password.md @@ -0,0 +1,8 @@ +[android-components](../index.md) / [mozilla.components.service.sync.logins](index.md) / [ServerPassword](./-server-password.md) + +# ServerPassword + +`typealias ServerPassword = ServerPassword` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L30) + +Raw password data that is stored by the storage implementation. + diff --git a/docs/api/mozilla.components.service.sync.logins/-sync-auth-invalid-exception.md b/docs/api/mozilla.components.service.sync.logins/-sync-auth-invalid-exception.md new file mode 100644 index 00000000000..48ffb92fa21 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-sync-auth-invalid-exception.md @@ -0,0 +1,11 @@ +[android-components](../index.md) / [mozilla.components.service.sync.logins](index.md) / [SyncAuthInvalidException](./-sync-auth-invalid-exception.md) + +# SyncAuthInvalidException + +`typealias SyncAuthInvalidException = SyncAuthInvalidException` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L50) + +This indicates that the authentication information (e.g. the [SyncUnlockInfo](-sync-unlock-info.md)) +provided to [AsyncLoginsStorage.sync](-async-logins-storage/sync.md) is invalid. This often indicates that it's +stale and should be refreshed with FxA (however, care should be taken not to +get into a loop refreshing this information). + diff --git a/docs/api/mozilla.components.service.sync.logins/-sync-unlock-info.md b/docs/api/mozilla.components.service.sync.logins/-sync-unlock-info.md new file mode 100644 index 00000000000..8617299a6c8 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-sync-unlock-info.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.service.sync.logins](index.md) / [SyncUnlockInfo](./-sync-unlock-info.md) + +# SyncUnlockInfo + +`typealias SyncUnlockInfo = SyncUnlockInfo` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L25) + +This type contains the set of information required to successfully +connect to the server and sync. + diff --git a/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/-init-.md b/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/-init-.md new file mode 100644 index 00000000000..4cb5530d1bd --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/-init-.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [SyncableLoginsStore](index.md) / [<init>](./-init-.md) + +# <init> + +`SyncableLoginsStore(store: `[`AsyncLoginsStorage`](../-async-logins-storage/index.md)`, key: () -> Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>)` + +Wraps [AsyncLoginsStorage](../-async-logins-storage/index.md) instance along with a lazy encryption key. + +This helper class lives here and not alongside [AsyncLoginsStorage](../-async-logins-storage/index.md) because we don't want to +force a `service-sync-logins` dependency (which has a heavy native library dependency) on +consumers of [FirefoxSyncFeature](#). + diff --git a/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/index.md b/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/index.md new file mode 100644 index 00000000000..316abb61239 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/index.md @@ -0,0 +1,31 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [SyncableLoginsStore](./index.md) + +# SyncableLoginsStore + +`data class SyncableLoginsStore : `[`SyncableStore`](../../mozilla.components.concept.storage/-syncable-store/index.md)`<`[`SyncUnlockInfo`](../-sync-unlock-info.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L369) + +Wraps [AsyncLoginsStorage](../-async-logins-storage/index.md) instance along with a lazy encryption key. + +This helper class lives here and not alongside [AsyncLoginsStorage](../-async-logins-storage/index.md) because we don't want to +force a `service-sync-logins` dependency (which has a heavy native library dependency) on +consumers of [FirefoxSyncFeature](#). + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SyncableLoginsStore(store: `[`AsyncLoginsStorage`](../-async-logins-storage/index.md)`, key: () -> Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>)`
Wraps [AsyncLoginsStorage](../-async-logins-storage/index.md) instance along with a lazy encryption key. | + +### Properties + +| Name | Summary | +|---|---| +| [key](key.md) | `val key: () -> Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` | +| [store](store.md) | `val store: `[`AsyncLoginsStorage`](../-async-logins-storage/index.md) | + +### Functions + +| Name | Summary | +|---|---| +| [sync](sync.md) | `suspend fun sync(authInfo: `[`SyncUnlockInfo`](../-sync-unlock-info.md)`): `[`SyncStatus`](../../mozilla.components.concept.storage/-sync-status.md)
Performs a sync. | +| [withUnlocked](with-unlocked.md) | `suspend fun withUnlocked(block: suspend (`[`AsyncLoginsStorage`](../-async-logins-storage/index.md)`) -> `[`T`](with-unlocked.md#T)`): `[`T`](with-unlocked.md#T)
Run some [block](with-unlocked.md#mozilla.components.service.sync.logins.SyncableLoginsStore$withUnlocked(kotlin.SuspendFunction1((mozilla.components.service.sync.logins.AsyncLoginsStorage, mozilla.components.service.sync.logins.SyncableLoginsStore.withUnlocked.T)))/block) which operates over an unlocked instance of [AsyncLoginsStorage](../-async-logins-storage/index.md). Database is locked once [block](with-unlocked.md#mozilla.components.service.sync.logins.SyncableLoginsStore$withUnlocked(kotlin.SuspendFunction1((mozilla.components.service.sync.logins.AsyncLoginsStorage, mozilla.components.service.sync.logins.SyncableLoginsStore.withUnlocked.T)))/block) is done. | diff --git a/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/key.md b/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/key.md new file mode 100644 index 00000000000..8185ca494cc --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/key.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [SyncableLoginsStore](index.md) / [key](./key.md) + +# key + +`val key: () -> Deferred<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L371) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/store.md b/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/store.md new file mode 100644 index 00000000000..ebbb82c9b91 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/store.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [SyncableLoginsStore](index.md) / [store](./store.md) + +# store + +`val store: `[`AsyncLoginsStorage`](../-async-logins-storage/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L370) \ No newline at end of file diff --git a/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/sync.md b/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/sync.md new file mode 100644 index 00000000000..00e68adc05c --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/sync.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [SyncableLoginsStore](index.md) / [sync](./sync.md) + +# sync + +`suspend fun sync(authInfo: `[`SyncUnlockInfo`](../-sync-unlock-info.md)`): `[`SyncStatus`](../../mozilla.components.concept.storage/-sync-status.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L373) + +Overrides [SyncableStore.sync](../../mozilla.components.concept.storage/-syncable-store/sync.md) + +Performs a sync. + +### Parameters + +`authInfo` - Auth information of type [AuthInfo](#) necessary for syncing this store. + +**Return** +[SyncStatus](../../mozilla.components.concept.storage/-sync-status.md) A status object describing how sync went. + diff --git a/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/with-unlocked.md b/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/with-unlocked.md new file mode 100644 index 00000000000..982072f2108 --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/-syncable-logins-store/with-unlocked.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.service.sync.logins](../index.md) / [SyncableLoginsStore](index.md) / [withUnlocked](./with-unlocked.md) + +# withUnlocked + +`suspend fun withUnlocked(block: suspend (`[`AsyncLoginsStorage`](../-async-logins-storage/index.md)`) -> `[`T`](with-unlocked.md#T)`): `[`T`](with-unlocked.md#T) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/sync-logins/src/main/java/mozilla/components/service/sync/logins/AsyncLoginsStorage.kt#L390) + +Run some [block](with-unlocked.md#mozilla.components.service.sync.logins.SyncableLoginsStore$withUnlocked(kotlin.SuspendFunction1((mozilla.components.service.sync.logins.AsyncLoginsStorage, mozilla.components.service.sync.logins.SyncableLoginsStore.withUnlocked.T)))/block) which operates over an unlocked instance of [AsyncLoginsStorage](../-async-logins-storage/index.md). +Database is locked once [block](with-unlocked.md#mozilla.components.service.sync.logins.SyncableLoginsStore$withUnlocked(kotlin.SuspendFunction1((mozilla.components.service.sync.logins.AsyncLoginsStorage, mozilla.components.service.sync.logins.SyncableLoginsStore.withUnlocked.T)))/block) is done. + +### Exceptions + +`InvalidKeyException` - if the provided [key](key.md) isn't valid. \ No newline at end of file diff --git a/docs/api/mozilla.components.service.sync.logins/index.md b/docs/api/mozilla.components.service.sync.logins/index.md new file mode 100644 index 00000000000..d470121ae6b --- /dev/null +++ b/docs/api/mozilla.components.service.sync.logins/index.md @@ -0,0 +1,26 @@ +[android-components](../index.md) / [mozilla.components.service.sync.logins](./index.md) + +## Package mozilla.components.service.sync.logins + +### Types + +| Name | Summary | +|---|---| +| [AsyncLoginsStorage](-async-logins-storage/index.md) | `interface AsyncLoginsStorage : `[`AutoCloseable`](https://developer.android.com/reference/java/lang/AutoCloseable.html)
An interface equivalent to the LoginsStorage interface, but where operations are asynchronous. | +| [AsyncLoginsStorageAdapter](-async-logins-storage-adapter/index.md) | `open class AsyncLoginsStorageAdapter : `[`AsyncLoginsStorage`](-async-logins-storage/index.md)`, `[`AutoCloseable`](https://developer.android.com/reference/java/lang/AutoCloseable.html)
A helper class to wrap a synchronous [LoginsStorage](#) implementation and make it asynchronous. | +| [SyncableLoginsStore](-syncable-logins-store/index.md) | `data class SyncableLoginsStore : `[`SyncableStore`](../mozilla.components.concept.storage/-syncable-store/index.md)`<`[`SyncUnlockInfo`](-sync-unlock-info.md)`>`
Wraps [AsyncLoginsStorage](-async-logins-storage/index.md) instance along with a lazy encryption key. | + +### Type Aliases + +| Name | Summary | +|---|---| +| [IdCollisionException](-id-collision-exception.md) | `typealias IdCollisionException = IdCollisionException`
This is thrown if `add()` is given a record whose `id` is not blank, and collides with a record already known to the storage instance. | +| [InvalidKeyException](-invalid-key-exception.md) | `typealias InvalidKeyException = InvalidKeyException`
This error is emitted in two cases: | +| [InvalidRecordException](-invalid-record-exception.md) | `typealias InvalidRecordException = InvalidRecordException`
This is thrown on attempts to insert or update a record so that it is no longer valid, where "invalid" is defined as such: | +| [LoginsStorageException](-logins-storage-exception.md) | `typealias LoginsStorageException = LoginsStorageException`
The base class of all errors emitted by logins storage. | +| [MismatchedLockException](-mismatched-lock-exception.md) | `typealias MismatchedLockException = MismatchedLockException`
This is thrown if `lock()`/`unlock()` pairs don't match up. | +| [NoSuchRecordException](-no-such-record-exception.md) | `typealias NoSuchRecordException = NoSuchRecordException`
This is thrown if `update()` is performed with a record whose ID does not exist. | +| [RequestFailedException](-request-failed-exception.md) | `typealias RequestFailedException = RequestFailedException`
This error is emitted if a request to a sync server failed. | +| [ServerPassword](-server-password.md) | `typealias ServerPassword = ServerPassword`
Raw password data that is stored by the storage implementation. | +| [SyncAuthInvalidException](-sync-auth-invalid-exception.md) | `typealias SyncAuthInvalidException = SyncAuthInvalidException`
This indicates that the authentication information (e.g. the [SyncUnlockInfo](-sync-unlock-info.md)) provided to [AsyncLoginsStorage.sync](-async-logins-storage/sync.md) is invalid. This often indicates that it's stale and should be refreshed with FxA (however, care should be taken not to get into a loop refreshing this information). | +| [SyncUnlockInfo](-sync-unlock-info.md) | `typealias SyncUnlockInfo = SyncUnlockInfo`
This type contains the set of information required to successfully connect to the server and sync. | diff --git a/docs/api/mozilla.components.support.base.android/-padding/-init-.md b/docs/api/mozilla.components.support.base.android/-padding/-init-.md new file mode 100644 index 00000000000..fd0f1b35bd9 --- /dev/null +++ b/docs/api/mozilla.components.support.base.android/-padding/-init-.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.support.base.android](../index.md) / [Padding](index.md) / [<init>](./-init-.md) + +# <init> + +`Padding(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)`)` + +A representation of an Android Padding. + +### Parameters + +`left` - Padding start in PX. + +`top` - Padding top in PX. + +`right` - Padding end in PX. + +`bottom` - Padding end in PX. \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.android/-padding/bottom.md b/docs/api/mozilla.components.support.base.android/-padding/bottom.md new file mode 100644 index 00000000000..4165632ce78 --- /dev/null +++ b/docs/api/mozilla.components.support.base.android/-padding/bottom.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.android](../index.md) / [Padding](index.md) / [bottom](./bottom.md) + +# bottom + +`val bottom: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/android/Padding.kt#L15) + +Padding end in PX. + diff --git a/docs/api/mozilla.components.support.base.android/-padding/index.md b/docs/api/mozilla.components.support.base.android/-padding/index.md new file mode 100644 index 00000000000..f09ed1ebc6d --- /dev/null +++ b/docs/api/mozilla.components.support.base.android/-padding/index.md @@ -0,0 +1,32 @@ +[android-components](../../index.md) / [mozilla.components.support.base.android](../index.md) / [Padding](./index.md) + +# Padding + +`data class Padding` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/android/Padding.kt#L15) + +A representation of an Android Padding. + +### Parameters + +`left` - Padding start in PX. + +`top` - Padding top in PX. + +`right` - Padding end in PX. + +`bottom` - Padding end in PX. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Padding(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)`)`
A representation of an Android Padding. | + +### Properties + +| Name | Summary | +|---|---| +| [bottom](bottom.md) | `val bottom: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Padding end in PX. | +| [left](left.md) | `val left: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Padding start in PX. | +| [right](right.md) | `val right: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Padding end in PX. | +| [top](top.md) | `val top: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Padding top in PX. | diff --git a/docs/api/mozilla.components.support.base.android/-padding/left.md b/docs/api/mozilla.components.support.base.android/-padding/left.md new file mode 100644 index 00000000000..ca86f9551b2 --- /dev/null +++ b/docs/api/mozilla.components.support.base.android/-padding/left.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.android](../index.md) / [Padding](index.md) / [left](./left.md) + +# left + +`val left: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/android/Padding.kt#L15) + +Padding start in PX. + diff --git a/docs/api/mozilla.components.support.base.android/-padding/right.md b/docs/api/mozilla.components.support.base.android/-padding/right.md new file mode 100644 index 00000000000..173a881e8e5 --- /dev/null +++ b/docs/api/mozilla.components.support.base.android/-padding/right.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.android](../index.md) / [Padding](index.md) / [right](./right.md) + +# right + +`val right: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/android/Padding.kt#L15) + +Padding end in PX. + diff --git a/docs/api/mozilla.components.support.base.android/-padding/top.md b/docs/api/mozilla.components.support.base.android/-padding/top.md new file mode 100644 index 00000000000..f54f567cc96 --- /dev/null +++ b/docs/api/mozilla.components.support.base.android/-padding/top.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.android](../index.md) / [Padding](index.md) / [top](./top.md) + +# top + +`val top: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/android/Padding.kt#L15) + +Padding top in PX. + diff --git a/docs/api/mozilla.components.support.base.android/index.md b/docs/api/mozilla.components.support.base.android/index.md new file mode 100644 index 00000000000..aa02b37ef8f --- /dev/null +++ b/docs/api/mozilla.components.support.base.android/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.support.base.android](./index.md) + +## Package mozilla.components.support.base.android + +### Types + +| Name | Summary | +|---|---| +| [Padding](-padding/index.md) | `data class Padding`
A representation of an Android Padding. | diff --git a/docs/api/mozilla.components.support.base.facts.processor/-log-fact-processor/-init-.md b/docs/api/mozilla.components.support.base.facts.processor/-log-fact-processor/-init-.md new file mode 100644 index 00000000000..4a5afb0b8c0 --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts.processor/-log-fact-processor/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts.processor](../index.md) / [LogFactProcessor](index.md) / [<init>](./-init-.md) + +# <init> + +`LogFactProcessor(logger: `[`Logger`](../../mozilla.components.support.base.log.logger/-logger/index.md)` = Logger("Facts"))` + +A [FactProcessor](../../mozilla.components.support.base.facts/-fact-processor/index.md) implementation that prints collected [Fact](../../mozilla.components.support.base.facts/-fact/index.md) instances to the log. + diff --git a/docs/api/mozilla.components.support.base.facts.processor/-log-fact-processor/index.md b/docs/api/mozilla.components.support.base.facts.processor/-log-fact-processor/index.md new file mode 100644 index 00000000000..d1bf5db6156 --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts.processor/-log-fact-processor/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts.processor](../index.md) / [LogFactProcessor](./index.md) + +# LogFactProcessor + +`class LogFactProcessor : `[`FactProcessor`](../../mozilla.components.support.base.facts/-fact-processor/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/processor/LogFactProcessor.kt#L14) + +A [FactProcessor](../../mozilla.components.support.base.facts/-fact-processor/index.md) implementation that prints collected [Fact](../../mozilla.components.support.base.facts/-fact/index.md) instances to the log. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `LogFactProcessor(logger: `[`Logger`](../../mozilla.components.support.base.log.logger/-logger/index.md)` = Logger("Facts"))`
A [FactProcessor](../../mozilla.components.support.base.facts/-fact-processor/index.md) implementation that prints collected [Fact](../../mozilla.components.support.base.facts/-fact/index.md) instances to the log. | + +### Functions + +| Name | Summary | +|---|---| +| [process](process.md) | `fun process(fact: `[`Fact`](../../mozilla.components.support.base.facts/-fact/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Passes the given [Fact](../../mozilla.components.support.base.facts/-fact/index.md) to the [FactProcessor](../../mozilla.components.support.base.facts/-fact-processor/index.md) for processing. | + +### Extension Functions + +| Name | Summary | +|---|---| +| [register](../../mozilla.components.support.base.facts/register.md) | `fun `[`FactProcessor`](../../mozilla.components.support.base.facts/-fact-processor/index.md)`.register(): `[`Facts`](../../mozilla.components.support.base.facts/-facts/index.md)
Registers this [FactProcessor](../../mozilla.components.support.base.facts/-fact-processor/index.md) to collect [Fact](../../mozilla.components.support.base.facts/-fact/index.md) instances from the [Facts](../../mozilla.components.support.base.facts/-facts/index.md) singleton. | diff --git a/docs/api/mozilla.components.support.base.facts.processor/-log-fact-processor/process.md b/docs/api/mozilla.components.support.base.facts.processor/-log-fact-processor/process.md new file mode 100644 index 00000000000..92695f77b65 --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts.processor/-log-fact-processor/process.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts.processor](../index.md) / [LogFactProcessor](index.md) / [process](./process.md) + +# process + +`fun process(fact: `[`Fact`](../../mozilla.components.support.base.facts/-fact/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/processor/LogFactProcessor.kt#L18) + +Overrides [FactProcessor.process](../../mozilla.components.support.base.facts/-fact-processor/process.md) + +Passes the given [Fact](../../mozilla.components.support.base.facts/-fact/index.md) to the [FactProcessor](../../mozilla.components.support.base.facts/-fact-processor/index.md) for processing. + diff --git a/docs/api/mozilla.components.support.base.facts.processor/index.md b/docs/api/mozilla.components.support.base.facts.processor/index.md new file mode 100644 index 00000000000..73788ac4ea5 --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts.processor/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.support.base.facts.processor](./index.md) + +## Package mozilla.components.support.base.facts.processor + +### Types + +| Name | Summary | +|---|---| +| [LogFactProcessor](-log-fact-processor/index.md) | `class LogFactProcessor : `[`FactProcessor`](../mozilla.components.support.base.facts/-fact-processor/index.md)
A [FactProcessor](../mozilla.components.support.base.facts/-fact-processor/index.md) implementation that prints collected [Fact](../mozilla.components.support.base.facts/-fact/index.md) instances to the log. | diff --git a/docs/api/mozilla.components.support.base.facts/-action/-c-l-i-c-k.md b/docs/api/mozilla.components.support.base.facts/-action/-c-l-i-c-k.md new file mode 100644 index 00000000000..f5a013becb6 --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/-action/-c-l-i-c-k.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts](../index.md) / [Action](index.md) / [CLICK](./-c-l-i-c-k.md) + +# CLICK + +`CLICK` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/Action.kt#L14) + +The user has clicked on something. + diff --git a/docs/api/mozilla.components.support.base.facts/-action/-c-o-m-m-i-t.md b/docs/api/mozilla.components.support.base.facts/-action/-c-o-m-m-i-t.md new file mode 100644 index 00000000000..6ec0ea3a21c --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/-action/-c-o-m-m-i-t.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts](../index.md) / [Action](index.md) / [COMMIT](./-c-o-m-m-i-t.md) + +# COMMIT + +`COMMIT` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/Action.kt#L27) + +The user has committed an input (e.g. entered text into an input field and then pressed enter). + diff --git a/docs/api/mozilla.components.support.base.facts/-action/-i-n-t-e-r-a-c-t-i-o-n.md b/docs/api/mozilla.components.support.base.facts/-action/-i-n-t-e-r-a-c-t-i-o-n.md new file mode 100644 index 00000000000..1dda6a570cf --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/-action/-i-n-t-e-r-a-c-t-i-o-n.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts](../index.md) / [Action](index.md) / [INTERACTION](./-i-n-t-e-r-a-c-t-i-o-n.md) + +# INTERACTION + +`INTERACTION` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/Action.kt#L34) + +A generic interaction that can be caused by a previous action (e.g. the user clicks on a button which causes a +[Fact](../-fact/index.md) with [CLICK](-c-l-i-c-k.md) action to be emitted. This click may causes something to load which emits a follow-up a +[Fact](../-fact/index.md) with [INTERACTION](./-i-n-t-e-r-a-c-t-i-o-n.md) action. + diff --git a/docs/api/mozilla.components.support.base.facts/-action/-t-o-g-g-l-e.md b/docs/api/mozilla.components.support.base.facts/-action/-t-o-g-g-l-e.md new file mode 100644 index 00000000000..e64c4cfba7e --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/-action/-t-o-g-g-l-e.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts](../index.md) / [Action](index.md) / [TOGGLE](./-t-o-g-g-l-e.md) + +# TOGGLE + +`TOGGLE` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/Action.kt#L22) + +The user has toggled something. + +Other than a click this action is performed on items that have a distinct number of states. For example clicking +a checkbox or switch widget could emit a [Fact](../-fact/index.md) with a [TOGGLE](./-t-o-g-g-l-e.md) action instead of a [CLICK](-c-l-i-c-k.md) action. + diff --git a/docs/api/mozilla.components.support.base.facts/-action/index.md b/docs/api/mozilla.components.support.base.facts/-action/index.md new file mode 100644 index 00000000000..5c818e7574b --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/-action/index.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts](../index.md) / [Action](./index.md) + +# Action + +`enum class Action` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/Action.kt#L10) + +A user or system action that causes [Fact](../-fact/index.md) instances to be emitted. + +### Enum Values + +| Name | Summary | +|---|---| +| [CLICK](-c-l-i-c-k.md) | The user has clicked on something. | +| [TOGGLE](-t-o-g-g-l-e.md) | The user has toggled something. | +| [COMMIT](-c-o-m-m-i-t.md) | The user has committed an input (e.g. entered text into an input field and then pressed enter). | +| [INTERACTION](-i-n-t-e-r-a-c-t-i-o-n.md) | A generic interaction that can be caused by a previous action (e.g. the user clicks on a button which causes a [Fact](../-fact/index.md) with [CLICK](-c-l-i-c-k.md) action to be emitted. This click may causes something to load which emits a follow-up a [Fact](../-fact/index.md) with [INTERACTION](-i-n-t-e-r-a-c-t-i-o-n.md) action. | diff --git a/docs/api/mozilla.components.support.base.facts/-fact-processor/index.md b/docs/api/mozilla.components.support.base.facts/-fact-processor/index.md new file mode 100644 index 00000000000..e1837f80d80 --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/-fact-processor/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts](../index.md) / [FactProcessor](./index.md) + +# FactProcessor + +`interface FactProcessor` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/FactProcessor.kt#L10) + +A [FactProcessor](./index.md) receives [Fact](../-fact/index.md) instances to process them further. + +### Functions + +| Name | Summary | +|---|---| +| [process](process.md) | `abstract fun process(fact: `[`Fact`](../-fact/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Passes the given [Fact](../-fact/index.md) to the [FactProcessor](./index.md) for processing. | + +### Extension Functions + +| Name | Summary | +|---|---| +| [register](../register.md) | `fun `[`FactProcessor`](./index.md)`.register(): `[`Facts`](../-facts/index.md)
Registers this [FactProcessor](./index.md) to collect [Fact](../-fact/index.md) instances from the [Facts](../-facts/index.md) singleton. | + +### Inheritors + +| Name | Summary | +|---|---| +| [LogFactProcessor](../../mozilla.components.support.base.facts.processor/-log-fact-processor/index.md) | `class LogFactProcessor : `[`FactProcessor`](./index.md)
A [FactProcessor](./index.md) implementation that prints collected [Fact](../-fact/index.md) instances to the log. | diff --git a/docs/api/mozilla.components.support.base.facts/-fact-processor/process.md b/docs/api/mozilla.components.support.base.facts/-fact-processor/process.md new file mode 100644 index 00000000000..baebfe17144 --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/-fact-processor/process.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts](../index.md) / [FactProcessor](index.md) / [process](./process.md) + +# process + +`abstract fun process(fact: `[`Fact`](../-fact/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/FactProcessor.kt#L14) + +Passes the given [Fact](../-fact/index.md) to the [FactProcessor](index.md) for processing. + diff --git a/docs/api/mozilla.components.support.base.facts/-fact/-init-.md b/docs/api/mozilla.components.support.base.facts/-fact/-init-.md new file mode 100644 index 00000000000..22b50ddb01c --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/-fact/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts](../index.md) / [Fact](index.md) / [<init>](./-init-.md) + +# <init> + +`Fact(component: Component, action: `[`Action`](../-action/index.md)`, item: `[`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)`? = null, metadata: `[`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)`>? = null)` + +A fact describing a generic event that has occurred in a component. + diff --git a/docs/api/mozilla.components.support.base.facts/-fact/action.md b/docs/api/mozilla.components.support.base.facts/-fact/action.md new file mode 100644 index 00000000000..30e7a14b540 --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/-fact/action.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts](../index.md) / [Fact](index.md) / [action](./action.md) + +# action + +`val action: `[`Action`](../-action/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/Fact.kt#L20) + +A user or system action that caused this fact (e.g. Action.CLICK). + +### Property + +`action` - A user or system action that caused this fact (e.g. Action.CLICK). \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.facts/-fact/component.md b/docs/api/mozilla.components.support.base.facts/-fact/component.md new file mode 100644 index 00000000000..23eb1c58076 --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/-fact/component.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts](../index.md) / [Fact](index.md) / [component](./component.md) + +# component + +`val component: Component` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/Fact.kt#L19) + +Component that emitted this fact. + +### Property + +`component` - Component that emitted this fact. \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.facts/-fact/index.md b/docs/api/mozilla.components.support.base.facts/-fact/index.md new file mode 100644 index 00000000000..d338e2e5511 --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/-fact/index.md @@ -0,0 +1,29 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts](../index.md) / [Fact](./index.md) + +# Fact + +`data class Fact` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/Fact.kt#L18) + +A fact describing a generic event that has occurred in a component. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Fact(component: Component, action: `[`Action`](../-action/index.md)`, item: `[`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)`? = null, metadata: `[`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)`>? = null)`
A fact describing a generic event that has occurred in a component. | + +### Properties + +| Name | Summary | +|---|---| +| [action](action.md) | `val action: `[`Action`](../-action/index.md)
A user or system action that caused this fact (e.g. Action.CLICK). | +| [component](component.md) | `val component: Component`
Component that emitted this fact. | +| [item](item.md) | `val item: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
An item that caused the action or that the action was performed on (e.g. "toolbar"). | +| [metadata](metadata.md) | `val metadata: `[`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)`>?`
A key/value map for facts where additional richer context is needed. | +| [value](value.md) | `val value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
An optional value providing more context. | + +### Extension Functions + +| Name | Summary | +|---|---| +| [collect](../collect.md) | `fun `[`Fact`](./index.md)`.collect(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Collect this fact through the [Facts](../-facts/index.md) singleton. | diff --git a/docs/api/mozilla.components.support.base.facts/-fact/item.md b/docs/api/mozilla.components.support.base.facts/-fact/item.md new file mode 100644 index 00000000000..3bec22abf8c --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/-fact/item.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts](../index.md) / [Fact](index.md) / [item](./item.md) + +# item + +`val item: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/Fact.kt#L21) + +An item that caused the action or that the action was performed on (e.g. "toolbar"). + +### Property + +`item` - An item that caused the action or that the action was performed on (e.g. "toolbar"). \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.facts/-fact/metadata.md b/docs/api/mozilla.components.support.base.facts/-fact/metadata.md new file mode 100644 index 00000000000..28686978894 --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/-fact/metadata.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts](../index.md) / [Fact](index.md) / [metadata](./metadata.md) + +# metadata + +`val metadata: `[`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)`>?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/Fact.kt#L23) + +A key/value map for facts where additional richer context is needed. + +### Property + +`metadata` - A key/value map for facts where additional richer context is needed. \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.facts/-fact/value.md b/docs/api/mozilla.components.support.base.facts/-fact/value.md new file mode 100644 index 00000000000..712cf7fccbe --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/-fact/value.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts](../index.md) / [Fact](index.md) / [value](./value.md) + +# value + +`val value: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/Fact.kt#L22) + +An optional value providing more context. + +### Property + +`value` - An optional value providing more context. \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.facts/-facts/collect.md b/docs/api/mozilla.components.support.base.facts/-facts/collect.md new file mode 100644 index 00000000000..c5bcf78b448 --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/-facts/collect.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts](../index.md) / [Facts](index.md) / [collect](./collect.md) + +# collect + +`fun collect(fact: `[`Fact`](../-fact/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/Facts.kt#L26) + +Collects a [Fact](../-fact/index.md) and forwards it to all registered [FactProcessor](../-fact-processor/index.md) instances. + diff --git a/docs/api/mozilla.components.support.base.facts/-facts/index.md b/docs/api/mozilla.components.support.base.facts/-facts/index.md new file mode 100644 index 00000000000..d7e879df65d --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/-facts/index.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts](../index.md) / [Facts](./index.md) + +# Facts + +`object Facts` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/Facts.kt#L12) + +Global API for collecting [Fact](../-fact/index.md) objects and forwarding them to [FactProcessor](../-fact-processor/index.md) instances. + +### Functions + +| Name | Summary | +|---|---| +| [collect](collect.md) | `fun collect(fact: `[`Fact`](../-fact/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Collects a [Fact](../-fact/index.md) and forwards it to all registered [FactProcessor](../-fact-processor/index.md) instances. | +| [registerProcessor](register-processor.md) | `fun registerProcessor(processor: `[`FactProcessor`](../-fact-processor/index.md)`): `[`Facts`](./index.md)
Registers a new [FactProcessor](../-fact-processor/index.md). | diff --git a/docs/api/mozilla.components.support.base.facts/-facts/register-processor.md b/docs/api/mozilla.components.support.base.facts/-facts/register-processor.md new file mode 100644 index 00000000000..bd5a9df8ed3 --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/-facts/register-processor.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.facts](../index.md) / [Facts](index.md) / [registerProcessor](./register-processor.md) + +# registerProcessor + +`fun registerProcessor(processor: `[`FactProcessor`](../-fact-processor/index.md)`): `[`Facts`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/Facts.kt#L18) + +Registers a new [FactProcessor](../-fact-processor/index.md). + diff --git a/docs/api/mozilla.components.support.base.facts/collect.md b/docs/api/mozilla.components.support.base.facts/collect.md new file mode 100644 index 00000000000..76373bbe879 --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/collect.md @@ -0,0 +1,8 @@ +[android-components](../index.md) / [mozilla.components.support.base.facts](index.md) / [collect](./collect.md) + +# collect + +`fun `[`Fact`](-fact/index.md)`.collect(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/Fact.kt#L29) + +Collect this fact through the [Facts](-facts/index.md) singleton. + diff --git a/docs/api/mozilla.components.support.base.facts/index.md b/docs/api/mozilla.components.support.base.facts/index.md new file mode 100644 index 00000000000..4cb0e917c85 --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/index.md @@ -0,0 +1,19 @@ +[android-components](../index.md) / [mozilla.components.support.base.facts](./index.md) + +## Package mozilla.components.support.base.facts + +### Types + +| Name | Summary | +|---|---| +| [Action](-action/index.md) | `enum class Action`
A user or system action that causes [Fact](-fact/index.md) instances to be emitted. | +| [Fact](-fact/index.md) | `data class Fact`
A fact describing a generic event that has occurred in a component. | +| [FactProcessor](-fact-processor/index.md) | `interface FactProcessor`
A [FactProcessor](-fact-processor/index.md) receives [Fact](-fact/index.md) instances to process them further. | +| [Facts](-facts/index.md) | `object Facts`
Global API for collecting [Fact](-fact/index.md) objects and forwarding them to [FactProcessor](-fact-processor/index.md) instances. | + +### Functions + +| Name | Summary | +|---|---| +| [collect](collect.md) | `fun `[`Fact`](-fact/index.md)`.collect(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Collect this fact through the [Facts](-facts/index.md) singleton. | +| [register](register.md) | `fun `[`FactProcessor`](-fact-processor/index.md)`.register(): `[`Facts`](-facts/index.md)
Registers this [FactProcessor](-fact-processor/index.md) to collect [Fact](-fact/index.md) instances from the [Facts](-facts/index.md) singleton. | diff --git a/docs/api/mozilla.components.support.base.facts/register.md b/docs/api/mozilla.components.support.base.facts/register.md new file mode 100644 index 00000000000..745f3f06627 --- /dev/null +++ b/docs/api/mozilla.components.support.base.facts/register.md @@ -0,0 +1,8 @@ +[android-components](../index.md) / [mozilla.components.support.base.facts](index.md) / [register](./register.md) + +# register + +`fun `[`FactProcessor`](-fact-processor/index.md)`.register(): `[`Facts`](-facts/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/facts/FactProcessor.kt#L20) + +Registers this [FactProcessor](-fact-processor/index.md) to collect [Fact](-fact/index.md) instances from the [Facts](-facts/index.md) singleton. + diff --git a/docs/api/mozilla.components.support.base.feature/-back-handler/index.md b/docs/api/mozilla.components.support.base.feature/-back-handler/index.md new file mode 100644 index 00000000000..c93c80387b5 --- /dev/null +++ b/docs/api/mozilla.components.support.base.feature/-back-handler/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.support.base.feature](../index.md) / [BackHandler](./index.md) + +# BackHandler + +`interface BackHandler` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/feature/BackHandler.kt#L10) + +Generic interface for fragments, features and other components that want to handle 'back' button presses. + +### Functions + +| Name | Summary | +|---|---| +| [onBackPressed](on-back-pressed.md) | `abstract fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Called when this [BackHandler](./index.md) gets the option to handle the user pressing the back key. | + +### Inheritors + +| Name | Summary | +|---|---| +| [CustomTabsToolbarFeature](../../mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/index.md) | `class CustomTabsToolbarFeature : `[`LifecycleAwareFeature`](../-lifecycle-aware-feature/index.md)`, `[`BackHandler`](./index.md)
Initializes and resets the Toolbar for a Custom Tab based on the CustomTabConfig. | +| [FindInPageFeature](../../mozilla.components.feature.findinpage/-find-in-page-feature/index.md) | `class FindInPageFeature : `[`LifecycleAwareFeature`](../-lifecycle-aware-feature/index.md)`, `[`BackHandler`](./index.md)
Feature implementation that will keep a [FindInPageView](../../mozilla.components.feature.findinpage.view/-find-in-page-view/index.md) in sync with a bound [Session](../../mozilla.components.browser.session/-session/index.md). | +| [FullScreenFeature](../../mozilla.components.feature.session/-full-screen-feature/index.md) | `open class FullScreenFeature : `[`SelectionAwareSessionObserver`](../../mozilla.components.browser.session/-selection-aware-session-observer/index.md)`, `[`LifecycleAwareFeature`](../-lifecycle-aware-feature/index.md)`, `[`BackHandler`](./index.md)
Feature implementation for handling fullscreen mode (exiting and back button presses). | +| [SessionFeature](../../mozilla.components.feature.session/-session-feature/index.md) | `class SessionFeature : `[`LifecycleAwareFeature`](../-lifecycle-aware-feature/index.md)`, `[`BackHandler`](./index.md)
Feature implementation for connecting the engine module with the session module. | +| [ToolbarFeature](../../mozilla.components.feature.toolbar/-toolbar-feature/index.md) | `class ToolbarFeature : `[`LifecycleAwareFeature`](../-lifecycle-aware-feature/index.md)`, `[`BackHandler`](./index.md)
Feature implementation for connecting a toolbar implementation with the session module. | diff --git a/docs/api/mozilla.components.support.base.feature/-back-handler/on-back-pressed.md b/docs/api/mozilla.components.support.base.feature/-back-handler/on-back-pressed.md new file mode 100644 index 00000000000..9f72bdc8a84 --- /dev/null +++ b/docs/api/mozilla.components.support.base.feature/-back-handler/on-back-pressed.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.support.base.feature](../index.md) / [BackHandler](index.md) / [onBackPressed](./on-back-pressed.md) + +# onBackPressed + +`abstract fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/feature/BackHandler.kt#L16) + +Called when this [BackHandler](index.md) gets the option to handle the user pressing the back key. + +Returns true if this [BackHandler](index.md) consumed the event and no other components need to be notified. + diff --git a/docs/api/mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md b/docs/api/mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md new file mode 100644 index 00000000000..b26fbfd4051 --- /dev/null +++ b/docs/api/mozilla.components.support.base.feature/-lifecycle-aware-feature/index.md @@ -0,0 +1,31 @@ +[android-components](../../index.md) / [mozilla.components.support.base.feature](../index.md) / [LifecycleAwareFeature](./index.md) + +# LifecycleAwareFeature + +`interface LifecycleAwareFeature : LifecycleObserver` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/feature/LifecycleAwareFeature.kt#L16) + +An interface for all entry points to feature components to implement in order to make them lifecycle aware. + +### Functions + +| Name | Summary | +|---|---| +| [start](start.md) | `abstract fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [stop](stop.md) | `abstract fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [ContextMenuFeature](../../mozilla.components.feature.contextmenu/-context-menu-feature/index.md) | `class ContextMenuFeature : `[`LifecycleAwareFeature`](./index.md)
Feature for displaying a context menu after long-pressing web content. | +| [CoordinateScrollingFeature](../../mozilla.components.feature.session/-coordinate-scrolling-feature/index.md) | `class CoordinateScrollingFeature : `[`SelectionAwareSessionObserver`](../../mozilla.components.browser.session/-selection-aware-session-observer/index.md)`, `[`LifecycleAwareFeature`](./index.md)
Feature implementation for connecting an [EngineView](../../mozilla.components.concept.engine/-engine-view/index.md) with any View that you want to coordinate scrolling behavior with. | +| [CustomTabsToolbarFeature](../../mozilla.components.feature.customtabs/-custom-tabs-toolbar-feature/index.md) | `class CustomTabsToolbarFeature : `[`LifecycleAwareFeature`](./index.md)`, `[`BackHandler`](../-back-handler/index.md)
Initializes and resets the Toolbar for a Custom Tab based on the CustomTabConfig. | +| [DownloadsFeature](../../mozilla.components.feature.downloads/-downloads-feature/index.md) | `class DownloadsFeature : `[`SelectionAwareSessionObserver`](../../mozilla.components.browser.session/-selection-aware-session-observer/index.md)`, `[`LifecycleAwareFeature`](./index.md)
Feature implementation to provide download functionality for the selected session. The feature will subscribe to the selected session and listen for downloads. | +| [FindInPageFeature](../../mozilla.components.feature.findinpage/-find-in-page-feature/index.md) | `class FindInPageFeature : `[`LifecycleAwareFeature`](./index.md)`, `[`BackHandler`](../-back-handler/index.md)
Feature implementation that will keep a [FindInPageView](../../mozilla.components.feature.findinpage.view/-find-in-page-view/index.md) in sync with a bound [Session](../../mozilla.components.browser.session/-session/index.md). | +| [FullScreenFeature](../../mozilla.components.feature.session/-full-screen-feature/index.md) | `open class FullScreenFeature : `[`SelectionAwareSessionObserver`](../../mozilla.components.browser.session/-selection-aware-session-observer/index.md)`, `[`LifecycleAwareFeature`](./index.md)`, `[`BackHandler`](../-back-handler/index.md)
Feature implementation for handling fullscreen mode (exiting and back button presses). | +| [PromptFeature](../../mozilla.components.feature.prompts/-prompt-feature/index.md) | `class PromptFeature : `[`LifecycleAwareFeature`](./index.md)
Feature for displaying native dialogs for html elements like: input type date, file, time, color, option, menu, authentication, confirmation and alerts. | +| [SessionFeature](../../mozilla.components.feature.session/-session-feature/index.md) | `class SessionFeature : `[`LifecycleAwareFeature`](./index.md)`, `[`BackHandler`](../-back-handler/index.md)
Feature implementation for connecting the engine module with the session module. | +| [SitePermissionsFeature](../../mozilla.components.feature.sitepermissions/-site-permissions-feature/index.md) | `class SitePermissionsFeature : `[`LifecycleAwareFeature`](./index.md)
This feature will subscribe to the currently selected [Session](../../mozilla.components.browser.session/-session/index.md) and display a suitable dialogs based on [Session.Observer.onAppPermissionRequested](../../mozilla.components.browser.session/-session/-observer/on-app-permission-requested.md) or [Session.Observer.onContentPermissionRequested](../../mozilla.components.browser.session/-session/-observer/on-content-permission-requested.md) events. Once the dialog is closed the [PermissionRequest](../../mozilla.components.concept.engine.permission/-permission-request/index.md) will be consumed. | +| [TabsFeature](../../mozilla.components.feature.tabs.tabstray/-tabs-feature/index.md) | `class TabsFeature : `[`LifecycleAwareFeature`](./index.md)
Feature implementation for connecting a tabs tray implementation with the session module. | +| [ToolbarFeature](../../mozilla.components.feature.toolbar/-toolbar-feature/index.md) | `class ToolbarFeature : `[`LifecycleAwareFeature`](./index.md)`, `[`BackHandler`](../-back-handler/index.md)
Feature implementation for connecting a toolbar implementation with the session module. | +| [WindowFeature](../../mozilla.components.feature.session/-window-feature/index.md) | `class WindowFeature : `[`LifecycleAwareFeature`](./index.md)
Feature implementation for handling window requests. | diff --git a/docs/api/mozilla.components.support.base.feature/-lifecycle-aware-feature/start.md b/docs/api/mozilla.components.support.base.feature/-lifecycle-aware-feature/start.md new file mode 100644 index 00000000000..14a9e02d64d --- /dev/null +++ b/docs/api/mozilla.components.support.base.feature/-lifecycle-aware-feature/start.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.base.feature](../index.md) / [LifecycleAwareFeature](index.md) / [start](./start.md) + +# start + +`abstract fun start(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/feature/LifecycleAwareFeature.kt#L18) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.feature/-lifecycle-aware-feature/stop.md b/docs/api/mozilla.components.support.base.feature/-lifecycle-aware-feature/stop.md new file mode 100644 index 00000000000..f7c18fee246 --- /dev/null +++ b/docs/api/mozilla.components.support.base.feature/-lifecycle-aware-feature/stop.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.base.feature](../index.md) / [LifecycleAwareFeature](index.md) / [stop](./stop.md) + +# stop + +`abstract fun stop(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/feature/LifecycleAwareFeature.kt#L21) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/-init-.md b/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/-init-.md new file mode 100644 index 00000000000..661ca62ad4f --- /dev/null +++ b/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/-init-.md @@ -0,0 +1,51 @@ +[android-components](../../index.md) / [mozilla.components.support.base.feature](../index.md) / [ViewBoundFeatureWrapper](index.md) / [<init>](./-init-.md) + +# <init> + +`ViewBoundFeatureWrapper(feature: `[`T`](index.md#T)`, owner: LifecycleOwner, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`)` + +Convenient constructor for creating a wrapper instance and calling [set](set.md) immediately. + +`ViewBoundFeatureWrapper()` + +Wrapper for [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) instances that keep a strong references to a [View](https://developer.android.com/reference/android/view/View.html). This wrapper is helpful +when the lifetime of the [View](https://developer.android.com/reference/android/view/View.html) may be shorter than the [Lifecycle](#) and you need to keep a reference to the +[LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) that may outlive the [View](https://developer.android.com/reference/android/view/View.html). + +[ViewBoundFeatureWrapper](index.md) takes care of stopping [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) and clearing references once the bound +[View](https://developer.android.com/reference/android/view/View.html) get detached. + +A common use case is a `Fragment` that needs to keep a reference to a [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) (e.g. to invoke +`onBackPressed()` and the [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) holds a reference to [View](https://developer.android.com/reference/android/view/View.html) instances. Once the `Fragment` gets +detached and not destroyed (e.g. when pushed to the back stack) it will still keep the reference to the +[LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) and therefore to the (now detached) [View](https://developer.android.com/reference/android/view/View.html) (-> Leak). When the `Fragment` gets re-attached a +new [View](https://developer.android.com/reference/android/view/View.html) and matching [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) is getting created leading to multiple concurrent +[LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) and (off-screen) [View](https://developer.android.com/reference/android/view/View.html) instances existing in memory. + +Example integration: + +``` +class MyFragment : Fragment { + val myFeature = ViewBoundFeatureWrapper() + + override fun onViewCreated(view: View, savedInstanceState: Bundle?) { + // Bind wrapper to feature and view. Feature will be stopped and internal reference will be cleared + // when the view gets detached. + myFeature.set( + feature = MyFeature(..., view), + owner = this, + view = view + ) + } + + fun doSomething() { + // Get will return the feature instance or null if the instance was cleared (e.g. the fragment is detached) + myFeature.get()?.doSomething() + } + + override fun onBackPressed(): Boolean { + return myFeature.onBackPressed() + } +} +``` + diff --git a/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/clear.md b/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/clear.md new file mode 100644 index 00000000000..672345d8c05 --- /dev/null +++ b/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/clear.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.feature](../index.md) / [ViewBoundFeatureWrapper](index.md) / [clear](./clear.md) + +# clear + +`@Synchronized fun clear(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/feature/ViewBoundFeatureWrapper.kt#L120) + +Stops the feature and clears all internal references and observers. + diff --git a/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/get.md b/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/get.md new file mode 100644 index 00000000000..04007201636 --- /dev/null +++ b/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/get.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.feature](../index.md) / [ViewBoundFeatureWrapper](index.md) / [get](./get.md) + +# get + +`@Synchronized fun get(): `[`T`](index.md#T)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/feature/ViewBoundFeatureWrapper.kt#L106) + +Returns the wrapped [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) or null if the [View](https://developer.android.com/reference/android/view/View.html) was detached and the reference was cleared. + diff --git a/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/index.md b/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/index.md new file mode 100644 index 00000000000..53eb48e2a3e --- /dev/null +++ b/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/index.md @@ -0,0 +1,62 @@ +[android-components](../../index.md) / [mozilla.components.support.base.feature](../index.md) / [ViewBoundFeatureWrapper](./index.md) + +# ViewBoundFeatureWrapper + +`class ViewBoundFeatureWrapper` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/feature/ViewBoundFeatureWrapper.kt#L56) + +Wrapper for [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) instances that keep a strong references to a [View](https://developer.android.com/reference/android/view/View.html). This wrapper is helpful +when the lifetime of the [View](https://developer.android.com/reference/android/view/View.html) may be shorter than the [Lifecycle](#) and you need to keep a reference to the +[LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) that may outlive the [View](https://developer.android.com/reference/android/view/View.html). + +[ViewBoundFeatureWrapper](./index.md) takes care of stopping [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) and clearing references once the bound +[View](https://developer.android.com/reference/android/view/View.html) get detached. + +A common use case is a `Fragment` that needs to keep a reference to a [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) (e.g. to invoke +`onBackPressed()` and the [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) holds a reference to [View](https://developer.android.com/reference/android/view/View.html) instances. Once the `Fragment` gets +detached and not destroyed (e.g. when pushed to the back stack) it will still keep the reference to the +[LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) and therefore to the (now detached) [View](https://developer.android.com/reference/android/view/View.html) (-> Leak). When the `Fragment` gets re-attached a +new [View](https://developer.android.com/reference/android/view/View.html) and matching [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) is getting created leading to multiple concurrent +[LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) and (off-screen) [View](https://developer.android.com/reference/android/view/View.html) instances existing in memory. + +Example integration: + +``` +class MyFragment : Fragment { + val myFeature = ViewBoundFeatureWrapper() + + override fun onViewCreated(view: View, savedInstanceState: Bundle?) { + // Bind wrapper to feature and view. Feature will be stopped and internal reference will be cleared + // when the view gets detached. + myFeature.set( + feature = MyFeature(..., view), + owner = this, + view = view + ) + } + + fun doSomething() { + // Get will return the feature instance or null if the instance was cleared (e.g. the fragment is detached) + myFeature.get()?.doSomething() + } + + override fun onBackPressed(): Boolean { + return myFeature.onBackPressed() + } +} +``` + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ViewBoundFeatureWrapper(feature: `[`T`](index.md#T)`, owner: LifecycleOwner, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`)`
Convenient constructor for creating a wrapper instance and calling [set](set.md) immediately.`ViewBoundFeatureWrapper()`
Wrapper for [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) instances that keep a strong references to a [View](https://developer.android.com/reference/android/view/View.html). This wrapper is helpful when the lifetime of the [View](https://developer.android.com/reference/android/view/View.html) may be shorter than the [Lifecycle](#) and you need to keep a reference to the [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) that may outlive the [View](https://developer.android.com/reference/android/view/View.html). | + +### Functions + +| Name | Summary | +|---|---| +| [clear](clear.md) | `fun clear(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Stops the feature and clears all internal references and observers. | +| [get](get.md) | `fun get(): `[`T`](index.md#T)`?`
Returns the wrapped [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) or null if the [View](https://developer.android.com/reference/android/view/View.html) was detached and the reference was cleared. | +| [onBackPressed](on-back-pressed.md) | `fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Convenient method for invoking [BackHandler.onBackPressed](../-back-handler/on-back-pressed.md) on a wrapped [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) that implements [BackHandler](../-back-handler/index.md). Returns false if the [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) was cleared already. | +| [set](set.md) | `fun set(feature: `[`T`](index.md#T)`, owner: LifecycleOwner, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Sets the [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) reference and binds it to the [Lifecycle](#) of the [LifecycleObserver](#) as well as the [View](https://developer.android.com/reference/android/view/View.html). | +| [withFeature](with-feature.md) | `fun withFeature(block: (`[`T`](index.md#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)
Runs the given [block](with-feature.md#mozilla.components.support.base.feature.ViewBoundFeatureWrapper$withFeature(kotlin.Function1((mozilla.components.support.base.feature.ViewBoundFeatureWrapper.T, kotlin.Unit)))/block) if this wrapper still has a reference to the [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md). | diff --git a/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/on-back-pressed.md b/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/on-back-pressed.md new file mode 100644 index 00000000000..fa1bdd9aa34 --- /dev/null +++ b/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/on-back-pressed.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.support.base.feature](../index.md) / [ViewBoundFeatureWrapper](index.md) / [onBackPressed](./on-back-pressed.md) + +# onBackPressed + +`@Synchronized fun onBackPressed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/feature/ViewBoundFeatureWrapper.kt#L145) + +Convenient method for invoking [BackHandler.onBackPressed](../-back-handler/on-back-pressed.md) on a wrapped [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) that implements +[BackHandler](../-back-handler/index.md). Returns false if the [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) was cleared already. + diff --git a/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/set.md b/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/set.md new file mode 100644 index 00000000000..49c42b8e8d8 --- /dev/null +++ b/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/set.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.support.base.feature](../index.md) / [ViewBoundFeatureWrapper](index.md) / [set](./set.md) + +# set + +`@Synchronized fun set(feature: `[`T`](index.md#T)`, owner: LifecycleOwner, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/feature/ViewBoundFeatureWrapper.kt#L84) + +Sets the [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) reference and binds it to the [Lifecycle](#) of the [LifecycleObserver](#) as well +as the [View](https://developer.android.com/reference/android/view/View.html). + +The wrapper will take care of subscribing to the [Lifecycle](#) and forwarding start/stop events to the +[LifecycleAwareFeature](../-lifecycle-aware-feature/index.md). + +Once the [View](https://developer.android.com/reference/android/view/View.html) gets detached the [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md) will be stopped and the wrapper will clear all +internal references. + diff --git a/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/with-feature.md b/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/with-feature.md new file mode 100644 index 00000000000..df532f4c0ce --- /dev/null +++ b/docs/api/mozilla.components.support.base.feature/-view-bound-feature-wrapper/with-feature.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.feature](../index.md) / [ViewBoundFeatureWrapper](index.md) / [withFeature](./with-feature.md) + +# withFeature + +`@Synchronized fun withFeature(block: (`[`T`](index.md#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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/feature/ViewBoundFeatureWrapper.kt#L112) + +Runs the given [block](with-feature.md#mozilla.components.support.base.feature.ViewBoundFeatureWrapper$withFeature(kotlin.Function1((mozilla.components.support.base.feature.ViewBoundFeatureWrapper.T, kotlin.Unit)))/block) if this wrapper still has a reference to the [LifecycleAwareFeature](../-lifecycle-aware-feature/index.md). + diff --git a/docs/api/mozilla.components.support.base.feature/index.md b/docs/api/mozilla.components.support.base.feature/index.md new file mode 100644 index 00000000000..c8207653091 --- /dev/null +++ b/docs/api/mozilla.components.support.base.feature/index.md @@ -0,0 +1,11 @@ +[android-components](../index.md) / [mozilla.components.support.base.feature](./index.md) + +## Package mozilla.components.support.base.feature + +### Types + +| Name | Summary | +|---|---| +| [BackHandler](-back-handler/index.md) | `interface BackHandler`
Generic interface for fragments, features and other components that want to handle 'back' button presses. | +| [LifecycleAwareFeature](-lifecycle-aware-feature/index.md) | `interface LifecycleAwareFeature : LifecycleObserver`
An interface for all entry points to feature components to implement in order to make them lifecycle aware. | +| [ViewBoundFeatureWrapper](-view-bound-feature-wrapper/index.md) | `class ViewBoundFeatureWrapper`
Wrapper for [LifecycleAwareFeature](-lifecycle-aware-feature/index.md) instances that keep a strong references to a [View](https://developer.android.com/reference/android/view/View.html). This wrapper is helpful when the lifetime of the [View](https://developer.android.com/reference/android/view/View.html) may be shorter than the [Lifecycle](#) and you need to keep a reference to the [LifecycleAwareFeature](-lifecycle-aware-feature/index.md) that may outlive the [View](https://developer.android.com/reference/android/view/View.html). | diff --git a/docs/api/mozilla.components.support.base.log.logger/-logger/-init-.md b/docs/api/mozilla.components.support.base.log.logger/-logger/-init-.md new file mode 100644 index 00000000000..94dc0253497 --- /dev/null +++ b/docs/api/mozilla.components.support.base.log.logger/-logger/-init-.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.base.log.logger](../index.md) / [Logger](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.support.base.log.logger/-logger/debug.md b/docs/api/mozilla.components.support.base.log.logger/-logger/debug.md new file mode 100644 index 00000000000..a4ef97faea9 --- /dev/null +++ b/docs/api/mozilla.components.support.base.log.logger/-logger/debug.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.support.base.log.logger](../index.md) / [Logger](index.md) / [debug](./debug.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/log/logger/Logger.kt#L21) +`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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/log/logger/Logger.kt#L74) + +Send a DEBUG log message. + diff --git a/docs/api/mozilla.components.support.base.log.logger/-logger/error.md b/docs/api/mozilla.components.support.base.log.logger/-logger/error.md new file mode 100644 index 00000000000..7d877ad2007 --- /dev/null +++ b/docs/api/mozilla.components.support.base.log.logger/-logger/error.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.support.base.log.logger](../index.md) / [Logger](index.md) / [error](./error.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/log/logger/Logger.kt#L42) +`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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/log/logger/Logger.kt#L89) + +Send a ERROR log message. + diff --git a/docs/api/mozilla.components.support.base.log.logger/-logger/index.md b/docs/api/mozilla.components.support.base.log.logger/-logger/index.md new file mode 100644 index 00000000000..bc16ed29d5c --- /dev/null +++ b/docs/api/mozilla.components.support.base.log.logger/-logger/index.md @@ -0,0 +1,37 @@ +[android-components](../../index.md) / [mozilla.components.support.base.log.logger](../index.md) / [Logger](./index.md) + +# Logger + +`class Logger` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/log/logger/Logger.kt#L15) + +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 + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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 + +| Name | Summary | +|---|---| +| [debug](debug.md) | `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.md) | `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.md) | `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.md) | `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.md) | `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 + +| Name | Summary | +|---|---| +| [debug](debug.md) | `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.md) | `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.md) | `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.md) | `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.md) | `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/mozilla.components.support.base.log.logger/-logger/info.md b/docs/api/mozilla.components.support.base.log.logger/-logger/info.md new file mode 100644 index 00000000000..1fc5a16fc45 --- /dev/null +++ b/docs/api/mozilla.components.support.base.log.logger/-logger/info.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.support.base.log.logger](../index.md) / [Logger](index.md) / [info](./info.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/log/logger/Logger.kt#L28) +`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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/log/logger/Logger.kt#L79) + +Send a INFO log message. + diff --git a/docs/api/mozilla.components.support.base.log.logger/-logger/measure.md b/docs/api/mozilla.components.support.base.log.logger/-logger/measure.md new file mode 100644 index 00000000000..eaed98f0e68 --- /dev/null +++ b/docs/api/mozilla.components.support.base.log.logger/-logger/measure.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.support.base.log.logger](../index.md) / [Logger](index.md) / [measure](./measure.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/log/logger/Logger.kt#L55) +`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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/log/logger/Logger.kt#L100) + +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/mozilla.components.support.base.log.logger/-logger/warn.md b/docs/api/mozilla.components.support.base.log.logger/-logger/warn.md new file mode 100644 index 00000000000..eb749aa2d26 --- /dev/null +++ b/docs/api/mozilla.components.support.base.log.logger/-logger/warn.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.support.base.log.logger](../index.md) / [Logger](index.md) / [warn](./warn.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/log/logger/Logger.kt#L35) +`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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/log/logger/Logger.kt#L84) + +Send a WARN log message. + diff --git a/docs/api/mozilla.components.support.base.log.logger/index.md b/docs/api/mozilla.components.support.base.log.logger/index.md new file mode 100644 index 00000000000..643471fff9a --- /dev/null +++ b/docs/api/mozilla.components.support.base.log.logger/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.support.base.log.logger](./index.md) + +## Package mozilla.components.support.base.log.logger + +### Types + +| Name | Summary | +|---|---| +| [Logger](-logger/index.md) | `class Logger`
A wrapper for the Log object providing a more convenient API for logging. | diff --git a/docs/api/mozilla.components.support.base.log.sink/-android-log-sink/-init-.md b/docs/api/mozilla.components.support.base.log.sink/-android-log-sink/-init-.md new file mode 100644 index 00000000000..dfe8d4ad05f --- /dev/null +++ b/docs/api/mozilla.components.support.base.log.sink/-android-log-sink/-init-.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.base.log.sink](../index.md) / [AndroidLogSink](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.support.base.log.sink/-android-log-sink/index.md b/docs/api/mozilla.components.support.base.log.sink/-android-log-sink/index.md new file mode 100644 index 00000000000..2f838c2bae8 --- /dev/null +++ b/docs/api/mozilla.components.support.base.log.sink/-android-log-sink/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.support.base.log.sink](../index.md) / [AndroidLogSink](./index.md) + +# AndroidLogSink + +`class AndroidLogSink : `[`LogSink`](../-log-sink/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/log/sink/AndroidLogSink.kt#L20) + +LogSink implementation that writes to Android's log. + +### Parameters + +`defaultTag` - A default tag that should be used for all logging calls without tag. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AndroidLogSink(defaultTag: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = "App")`
LogSink implementation that writes to Android's log. | + +### Functions + +| Name | Summary | +|---|---| +| [log](log.md) | `fun log(priority: `[`Priority`](../../mozilla.components.support.base.log/-log/-priority/index.md)`, 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/mozilla.components.support.base.log.sink/-android-log-sink/log.md b/docs/api/mozilla.components.support.base.log.sink/-android-log-sink/log.md new file mode 100644 index 00000000000..75b6b080d67 --- /dev/null +++ b/docs/api/mozilla.components.support.base.log.sink/-android-log-sink/log.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.support.base.log.sink](../index.md) / [AndroidLogSink](index.md) / [log](./log.md) + +# log + +`fun log(priority: `[`Priority`](../../mozilla.components.support.base.log/-log/-priority/index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/log/sink/AndroidLogSink.kt#L26) + +Overrides [LogSink.log](../-log-sink/log.md) + +Low-level logging call. + diff --git a/docs/api/mozilla.components.support.base.log.sink/-log-sink/index.md b/docs/api/mozilla.components.support.base.log.sink/-log-sink/index.md new file mode 100644 index 00000000000..b3dc84b3eb2 --- /dev/null +++ b/docs/api/mozilla.components.support.base.log.sink/-log-sink/index.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.support.base.log.sink](../index.md) / [LogSink](./index.md) + +# LogSink + +`interface LogSink` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/log/sink/LogSink.kt#L9) + +### Functions + +| Name | Summary | +|---|---| +| [log](log.md) | `abstract fun log(priority: `[`Priority`](../../mozilla.components.support.base.log/-log/-priority/index.md)` = 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 + +| Name | Summary | +|---|---| +| [AndroidLogSink](../-android-log-sink/index.md) | `class AndroidLogSink : `[`LogSink`](./index.md)
LogSink implementation that writes to Android's log. | diff --git a/docs/api/mozilla.components.support.base.log.sink/-log-sink/log.md b/docs/api/mozilla.components.support.base.log.sink/-log-sink/log.md new file mode 100644 index 00000000000..1e7135238fb --- /dev/null +++ b/docs/api/mozilla.components.support.base.log.sink/-log-sink/log.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.base.log.sink](../index.md) / [LogSink](index.md) / [log](./log.md) + +# log + +`abstract fun log(priority: `[`Priority`](../../mozilla.components.support.base.log/-log/-priority/index.md)` = 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/log/sink/LogSink.kt#L10) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.log.sink/index.md b/docs/api/mozilla.components.support.base.log.sink/index.md new file mode 100644 index 00000000000..408fccfd659 --- /dev/null +++ b/docs/api/mozilla.components.support.base.log.sink/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.support.base.log.sink](./index.md) + +## Package mozilla.components.support.base.log.sink + +### Types + +| Name | Summary | +|---|---| +| [AndroidLogSink](-android-log-sink/index.md) | `class AndroidLogSink : `[`LogSink`](-log-sink/index.md)
LogSink implementation that writes to Android's log. | +| [LogSink](-log-sink/index.md) | `interface LogSink` | diff --git a/docs/api/mozilla.components.support.base.observer/-consumable-stream/append.md b/docs/api/mozilla.components.support.base.observer/-consumable-stream/append.md new file mode 100644 index 00000000000..219c86efeb2 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-consumable-stream/append.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ConsumableStream](index.md) / [append](./append.md) + +# append + +`@Synchronized fun append(vararg values: `[`T`](index.md#T)`): `[`ConsumableStream`](index.md)`<`[`T`](index.md#T)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Consumable.kt#L134) + +Copies the stream and appends the provided values. + +### Parameters + +`values` - the values to append. + +**Return** +a new consumable stream with the values appended. + diff --git a/docs/api/mozilla.components.support.base.observer/-consumable-stream/consume-all-by.md b/docs/api/mozilla.components.support.base.observer/-consumable-stream/consume-all-by.md new file mode 100644 index 00000000000..fe4fced389a --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-consumable-stream/consume-all-by.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ConsumableStream](index.md) / [consumeAllBy](./consume-all-by.md) + +# consumeAllBy + +`@Synchronized fun consumeAllBy(consumers: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<(`[`T`](index.md#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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Consumable.kt#L122) + +Invokes the given list of lambdas for each consumable value and marks the +values as consumed if at least one lambda returns true. + +### Parameters + +`consumers` - the lambdas accepting a consumable value. + +**Return** +true if all consumables were consumed, otherwise false. + diff --git a/docs/api/mozilla.components.support.base.observer/-consumable-stream/consume-all.md b/docs/api/mozilla.components.support.base.observer/-consumable-stream/consume-all.md new file mode 100644 index 00000000000..97fc0de37c6 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-consumable-stream/consume-all.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ConsumableStream](index.md) / [consumeAll](./consume-all.md) + +# consumeAll + +`@Synchronized fun consumeAll(consumer: (value: `[`T`](index.md#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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Consumable.kt#L96) + +Invokes the given lambda for each consumable value and marks the values +as consumed if the lambda returns true. + +### Parameters + +`consumer` - a lambda accepting a consumable value. + +**Return** +true if all consumables were consumed, otherwise false. + diff --git a/docs/api/mozilla.components.support.base.observer/-consumable-stream/consume-next-by.md b/docs/api/mozilla.components.support.base.observer/-consumable-stream/consume-next-by.md new file mode 100644 index 00000000000..16c6d69119c --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-consumable-stream/consume-next-by.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ConsumableStream](index.md) / [consumeNextBy](./consume-next-by.md) + +# consumeNextBy + +`@Synchronized fun consumeNextBy(consumers: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<(`[`T`](index.md#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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Consumable.kt#L109) + +Invokes the given list of lambdas with the next consumable value and marks the +value as consumed if at least one lambda returns true. + +### Parameters + +`consumers` - the lambdas accepting the next consumable value. + +**Return** +true if the consumable was consumed, otherwise false. + diff --git a/docs/api/mozilla.components.support.base.observer/-consumable-stream/consume-next.md b/docs/api/mozilla.components.support.base.observer/-consumable-stream/consume-next.md new file mode 100644 index 00000000000..60c5fad70fb --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-consumable-stream/consume-next.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ConsumableStream](index.md) / [consumeNext](./consume-next.md) + +# consumeNext + +`@Synchronized fun consumeNext(consumer: (value: `[`T`](index.md#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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Consumable.kt#L83) + +Invokes the given lambda with the next consumable value and marks the value +as consumed if the lambda returns true. + +### Parameters + +`consumer` - a lambda accepting a consumable value. + +**Return** +true if the consumable was consumed, otherwise false. + diff --git a/docs/api/mozilla.components.support.base.observer/-consumable-stream/index.md b/docs/api/mozilla.components.support.base.observer/-consumable-stream/index.md new file mode 100644 index 00000000000..50d985c5d6e --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-consumable-stream/index.md @@ -0,0 +1,22 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ConsumableStream](./index.md) + +# ConsumableStream + +`class ConsumableStream` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Consumable.kt#L73) + +A generic wrapper for a stream of values that can be consumed. Values will +be consumed first in, first out. + +### Functions + +| Name | Summary | +|---|---| +| [append](append.md) | `fun append(vararg values: `[`T`](index.md#T)`): `[`ConsumableStream`](./index.md)`<`[`T`](index.md#T)`>`
Copies the stream and appends the provided values. | +| [consumeAll](consume-all.md) | `fun consumeAll(consumer: (value: `[`T`](index.md#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 for each consumable value and marks the values as consumed if the lambda returns true. | +| [consumeAllBy](consume-all-by.md) | `fun consumeAllBy(consumers: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<(`[`T`](index.md#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 for each consumable value and marks the values as consumed if at least one lambda returns true. | +| [consumeNext](consume-next.md) | `fun consumeNext(consumer: (value: `[`T`](index.md#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 with the next consumable value and marks the value as consumed if the lambda returns true. | +| [consumeNextBy](consume-next-by.md) | `fun consumeNextBy(consumers: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<(`[`T`](index.md#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 with the next consumable value and marks the value as consumed if at least one lambda returns true. | +| [isConsumed](is-consumed.md) | `fun isConsumed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true if all values in this stream were consumed, otherwise false. | +| [isEmpty](is-empty.md) | `fun isEmpty(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true if the stream is empty, otherwise false. | +| [remove](remove.md) | `fun remove(value: `[`T`](index.md#T)`): `[`ConsumableStream`](./index.md)`<`[`T`](index.md#T)`>`
Copies the stream but removes all consumables equal to the provided value. | +| [removeConsumed](remove-consumed.md) | `fun removeConsumed(): `[`ConsumableStream`](./index.md)`<`[`T`](index.md#T)`>`
Copies the stream but removes all consumed values. | diff --git a/docs/api/mozilla.components.support.base.observer/-consumable-stream/is-consumed.md b/docs/api/mozilla.components.support.base.observer/-consumable-stream/is-consumed.md new file mode 100644 index 00000000000..05009b279dc --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-consumable-stream/is-consumed.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ConsumableStream](index.md) / [isConsumed](./is-consumed.md) + +# isConsumed + +`@Synchronized fun isConsumed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Consumable.kt#L160) + +Returns true if all values in this stream were consumed, otherwise false. + diff --git a/docs/api/mozilla.components.support.base.observer/-consumable-stream/is-empty.md b/docs/api/mozilla.components.support.base.observer/-consumable-stream/is-empty.md new file mode 100644 index 00000000000..f1e96490873 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-consumable-stream/is-empty.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ConsumableStream](index.md) / [isEmpty](./is-empty.md) + +# isEmpty + +`@Synchronized fun isEmpty(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Consumable.kt#L166) + +Returns true if the stream is empty, otherwise false. + diff --git a/docs/api/mozilla.components.support.base.observer/-consumable-stream/remove-consumed.md b/docs/api/mozilla.components.support.base.observer/-consumable-stream/remove-consumed.md new file mode 100644 index 00000000000..4328b564c86 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-consumable-stream/remove-consumed.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ConsumableStream](index.md) / [removeConsumed](./remove-consumed.md) + +# removeConsumed + +`@Synchronized fun removeConsumed(): `[`ConsumableStream`](index.md)`<`[`T`](index.md#T)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Consumable.kt#L153) + +Copies the stream but removes all consumed values. + +**Return** +a new consumable stream with the consumed values removed. + diff --git a/docs/api/mozilla.components.support.base.observer/-consumable-stream/remove.md b/docs/api/mozilla.components.support.base.observer/-consumable-stream/remove.md new file mode 100644 index 00000000000..956f5ee534e --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-consumable-stream/remove.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ConsumableStream](index.md) / [remove](./remove.md) + +# remove + +`@Synchronized fun remove(value: `[`T`](index.md#T)`): `[`ConsumableStream`](index.md)`<`[`T`](index.md#T)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Consumable.kt#L144) + +Copies the stream but removes all consumables equal to the provided value. + +### Parameters + +`value` - the value to remove. + +**Return** +a new consumable stream with the matching values removed. + diff --git a/docs/api/mozilla.components.support.base.observer/-consumable/consume-by.md b/docs/api/mozilla.components.support.base.observer/-consumable/consume-by.md new file mode 100644 index 00000000000..5b285e44489 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-consumable/consume-by.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [Consumable](index.md) / [consumeBy](./consume-by.md) + +# consumeBy + +`@Synchronized fun consumeBy(consumers: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<(`[`T`](index.md#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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Consumable.kt#L31) + +Invokes the given list of lambdas and marks the value as consumed if at least one lambda +returns true. + diff --git a/docs/api/mozilla.components.support.base.observer/-consumable/consume.md b/docs/api/mozilla.components.support.base.observer/-consumable/consume.md new file mode 100644 index 00000000000..d4c44d77b1e --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-consumable/consume.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [Consumable](index.md) / [consume](./consume.md) + +# consume + +`@Synchronized fun consume(consumer: (value: `[`T`](index.md#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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Consumable.kt#L17) + +Invokes the given lambda and marks the value as consumed if the lambda returns true. + diff --git a/docs/api/mozilla.components.support.base.observer/-consumable/empty.md b/docs/api/mozilla.components.support.base.observer/-consumable/empty.md new file mode 100644 index 00000000000..25cc22d8835 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-consumable/empty.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [Consumable](index.md) / [empty](./empty.md) + +# empty + +`fun empty(): `[`Consumable`](index.md)`<`[`T`](empty.md#T)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Consumable.kt#L65) + +Returns an empty Consumable with not value as if it was consumed already. + diff --git a/docs/api/mozilla.components.support.base.observer/-consumable/from.md b/docs/api/mozilla.components.support.base.observer/-consumable/from.md new file mode 100644 index 00000000000..0aeede7b24c --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-consumable/from.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [Consumable](index.md) / [from](./from.md) + +# from + +`fun from(value: `[`T`](from.md#T)`): `[`Consumable`](index.md)`<`[`T`](from.md#T)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Consumable.kt#L53) + +Creates a new Consumable wrapping the given value. + diff --git a/docs/api/mozilla.components.support.base.observer/-consumable/index.md b/docs/api/mozilla.components.support.base.observer/-consumable/index.md new file mode 100644 index 00000000000..461b47f1c52 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-consumable/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [Consumable](./index.md) + +# Consumable + +`class Consumable` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Consumable.kt#L10) + +A generic wrapper for values that can get consumed. + +### Functions + +| Name | Summary | +|---|---| +| [consume](consume.md) | `fun consume(consumer: (value: `[`T`](index.md#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.md) | `fun consumeBy(consumers: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<(`[`T`](index.md#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 returns true. | +| [isConsumed](is-consumed.md) | `fun isConsumed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns whether the value was consumed. | + +### Companion Object Functions + +| Name | Summary | +|---|---| +| [empty](empty.md) | `fun empty(): `[`Consumable`](./index.md)`<`[`T`](empty.md#T)`>`
Returns an empty Consumable with not value as if it was consumed already. | +| [from](from.md) | `fun from(value: `[`T`](from.md#T)`): `[`Consumable`](./index.md)`<`[`T`](from.md#T)`>`
Creates a new Consumable wrapping the given value. | +| [stream](stream.md) | `fun stream(vararg values: `[`T`](stream.md#T)`): `[`ConsumableStream`](../-consumable-stream/index.md)`<`[`T`](stream.md#T)`>`
Creates a new Consumable stream for the provided values. | diff --git a/docs/api/mozilla.components.support.base.observer/-consumable/is-consumed.md b/docs/api/mozilla.components.support.base.observer/-consumable/is-consumed.md new file mode 100644 index 00000000000..8564058e5ce --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-consumable/is-consumed.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [Consumable](index.md) / [isConsumed](./is-consumed.md) + +# isConsumed + +`@Synchronized fun isConsumed(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Consumable.kt#L47) + +Returns whether the value was consumed. + diff --git a/docs/api/mozilla.components.support.base.observer/-consumable/stream.md b/docs/api/mozilla.components.support.base.observer/-consumable/stream.md new file mode 100644 index 00000000000..ee0da435707 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-consumable/stream.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [Consumable](index.md) / [stream](./stream.md) + +# stream + +`fun stream(vararg values: `[`T`](stream.md#T)`): `[`ConsumableStream`](../-consumable-stream/index.md)`<`[`T`](stream.md#T)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Consumable.kt#L58) + +Creates a new Consumable stream for the provided values. + diff --git a/docs/api/mozilla.components.support.base.observer/-observable/index.md b/docs/api/mozilla.components.support.base.observer/-observable/index.md new file mode 100644 index 00000000000..e9eb0916c17 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-observable/index.md @@ -0,0 +1,39 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [Observable](./index.md) + +# Observable + +`interface Observable` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Observable.kt#L18) + +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 + +| Name | Summary | +|---|---| +| [notifyObservers](notify-observers.md) | `abstract fun notifyObservers(block: `[`T`](index.md#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)
Notifies all registered observers about a change. | +| [pauseObserver](pause-observer.md) | `abstract fun pauseObserver(observer: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Pauses the provided observer. No notifications will be sent to this observer until [resumeObserver](resume-observer.md) is called. | +| [register](register.md) | `abstract fun register(observer: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
`abstract fun register(observer: `[`T`](index.md#T)`, owner: LifecycleOwner, autoPause: `[`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)
`abstract fun register(observer: `[`T`](index.md#T)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Registers an observer to get notified about changes. | +| [resumeObserver](resume-observer.md) | `abstract fun resumeObserver(observer: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Resumes the provided observer. Notifications sent since it was last paused (see [pauseObserver](pause-observer.md)]) are lost and will not be re-delivered. | +| [unregister](unregister.md) | `abstract fun unregister(observer: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Unregisters an observer. | +| [unregisterObservers](unregister-observers.md) | `abstract fun unregisterObservers(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Unregisters all observers. | +| [wrapConsumers](wrap-consumers.md) | `abstract fun wrapConsumers(block: `[`T`](index.md#T)`.(`[`R`](wrap-consumers.md#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.md#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 + +| Name | Summary | +|---|---| +| [EngineSession](../../mozilla.components.concept.engine/-engine-session/index.md) | `abstract class EngineSession : `[`Observable`](./index.md)`<`[`Observer`](../../mozilla.components.concept.engine/-engine-session/-observer/index.md)`>`
Class representing a single engine session. | +| [FirefoxSyncFeature](../../mozilla.components.feature.sync/-firefox-sync-feature/index.md) | `class FirefoxSyncFeature : `[`Observable`](./index.md)`<`[`SyncStatusObserver`](../../mozilla.components.feature.sync/-sync-status-observer/index.md)`>`
A feature implementation which orchestrates data synchronization of a set of [SyncableStore](../../mozilla.components.concept.storage/-syncable-store/index.md) which all share a common [AuthType](../../mozilla.components.feature.sync/-firefox-sync-feature/index.md#AuthType). | +| [FxaAccountManager](../../mozilla.components.service.fxa/-fxa-account-manager/index.md) | `open class FxaAccountManager : `[`Closeable`](https://developer.android.com/reference/java/io/Closeable.html)`, `[`Observable`](./index.md)`<`[`AccountObserver`](../../mozilla.components.service.fxa/-account-observer/index.md)`>`
An account manager which encapsulates various internal details of an account lifecycle and provides an observer interface along with a public API for interacting with an account. The internal state machine abstracts over state space as exposed by the fxaclient library, not the internal states experienced by lower-level representation of a Firefox Account; those are opaque to us. | +| [ObserverRegistry](../-observer-registry/index.md) | `class ObserverRegistry : `[`Observable`](./index.md)`<`[`T`](../-observer-registry/index.md#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. | +| [Session](../../mozilla.components.browser.session/-session/index.md) | `class Session : `[`Observable`](./index.md)`<`[`Observer`](../../mozilla.components.browser.session/-session/-observer/index.md)`>`
Value type that represents the state of a browser session. Changes can be observed. | +| [SessionManager](../../mozilla.components.browser.session/-session-manager/index.md) | `class SessionManager : `[`Observable`](./index.md)`<`[`Observer`](../../mozilla.components.browser.session/-session-manager/-observer/index.md)`>`
This class provides access to a centralized registry of all active sessions. | +| [TabsAdapter](../../mozilla.components.browser.tabstray/-tabs-adapter/index.md) | `class TabsAdapter : Adapter<`[`TabViewHolder`](../../mozilla.components.browser.tabstray/-tab-view-holder/index.md)`>, `[`TabsTray`](../../mozilla.components.concept.tabstray/-tabs-tray/index.md)`, `[`Observable`](./index.md)`<`[`Observer`](../../mozilla.components.concept.tabstray/-tabs-tray/-observer/index.md)`>`
RecyclerView adapter implementation to display a list/grid of tabs. | +| [TabsTray](../../mozilla.components.concept.tabstray/-tabs-tray/index.md) | `interface TabsTray : `[`Observable`](./index.md)`<`[`Observer`](../../mozilla.components.concept.tabstray/-tabs-tray/-observer/index.md)`>`
Generic interface for components that provide "tabs tray" functionality. | diff --git a/docs/api/mozilla.components.support.base.observer/-observable/notify-observers.md b/docs/api/mozilla.components.support.base.observer/-observable/notify-observers.md new file mode 100644 index 00000000000..641862d6f8e --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-observable/notify-observers.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [Observable](index.md) / [notifyObservers](./notify-observers.md) + +# notifyObservers + +`abstract fun notifyObservers(block: `[`T`](index.md#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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Observable.kt#L67) + +Notifies all registered observers about a change. + +### Parameters + +`block` - the notification (method on the observer to be invoked). \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.observer/-observable/pause-observer.md b/docs/api/mozilla.components.support.base.observer/-observable/pause-observer.md new file mode 100644 index 00000000000..7bc94278f97 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-observable/pause-observer.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [Observable](index.md) / [pauseObserver](./pause-observer.md) + +# pauseObserver + +`abstract fun pauseObserver(observer: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Observable.kt#L75) + +Pauses the provided observer. No notifications will be sent to this +observer until [resumeObserver](resume-observer.md) is called. + +### Parameters + +`observer` - the observer to pause. \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.observer/-observable/register.md b/docs/api/mozilla.components.support.base.observer/-observable/register.md new file mode 100644 index 00000000000..5281ccdf805 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-observable/register.md @@ -0,0 +1,36 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [Observable](index.md) / [register](./register.md) + +# register + +`abstract fun register(observer: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Observable.kt#L24) + +Registers an observer to get notified about changes. + +### Parameters + +`observer` - the observer to register.`abstract fun register(observer: `[`T`](index.md#T)`, owner: LifecycleOwner, autoPause: `[`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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Observable.kt#L37) + +Registers an observer to get notified about changes. + +The observer will automatically unsubscribe if the lifecycle of the provided LifecycleOwner +becomes DESTROYED. + +### Parameters + +`observer` - the observer to register. + +`owner` - the lifecycle owner the provided observer is bound to. + +`autoPause` - whether or not the observer should automatically be +paused/resumed with the bound lifecycle.`abstract fun register(observer: `[`T`](index.md#T)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Observable.kt#L48) + +Registers an observer to get notified about changes. + +The observer will only be notified if the view is attached and will be unregistered/ +registered if the attached state changes. + +### Parameters + +`observer` - the observer to register. + +`view` - the view the provided observer is bound to. \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.observer/-observable/resume-observer.md b/docs/api/mozilla.components.support.base.observer/-observable/resume-observer.md new file mode 100644 index 00000000000..1f59617c80e --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-observable/resume-observer.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [Observable](index.md) / [resumeObserver](./resume-observer.md) + +# resumeObserver + +`abstract fun resumeObserver(observer: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Observable.kt#L84) + +Resumes the provided observer. Notifications sent since it +was last paused (see [pauseObserver](pause-observer.md)]) are lost and will not be +re-delivered. + +### Parameters + +`observer` - the observer to resume. \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.observer/-observable/unregister-observers.md b/docs/api/mozilla.components.support.base.observer/-observable/unregister-observers.md new file mode 100644 index 00000000000..cc453e0dba8 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-observable/unregister-observers.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [Observable](index.md) / [unregisterObservers](./unregister-observers.md) + +# unregisterObservers + +`abstract fun unregisterObservers(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Observable.kt#L60) + +Unregisters all observers. + diff --git a/docs/api/mozilla.components.support.base.observer/-observable/unregister.md b/docs/api/mozilla.components.support.base.observer/-observable/unregister.md new file mode 100644 index 00000000000..d058b463542 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-observable/unregister.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [Observable](index.md) / [unregister](./unregister.md) + +# unregister + +`abstract fun unregister(observer: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Observable.kt#L55) + +Unregisters an observer. + +### Parameters + +`observer` - the observer to unregister. \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.observer/-observable/wrap-consumers.md b/docs/api/mozilla.components.support.base.observer/-observable/wrap-consumers.md new file mode 100644 index 00000000000..2999fbb38de --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-observable/wrap-consumers.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [Observable](index.md) / [wrapConsumers](./wrap-consumers.md) + +# wrapConsumers + +`abstract fun wrapConsumers(block: `[`T`](index.md#T)`.(`[`R`](wrap-consumers.md#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.md#R)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/Observable.kt#L89) + +Returns a list of lambdas wrapping a consuming method of an observer. + diff --git a/docs/api/mozilla.components.support.base.observer/-observer-registry/-init-.md b/docs/api/mozilla.components.support.base.observer/-observer-registry/-init-.md new file mode 100644 index 00000000000..ada53ccd092 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-observer-registry/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ObserverRegistry](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.support.base.observer/-observer-registry/index.md b/docs/api/mozilla.components.support.base.observer/-observer-registry/index.md new file mode 100644 index 00000000000..07651d2444d --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-observer-registry/index.md @@ -0,0 +1,26 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ObserverRegistry](./index.md) + +# ObserverRegistry + +`class ObserverRegistry : `[`Observable`](../-observable/index.md)`<`[`T`](index.md#T)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/ObserverRegistry.kt#L18) + +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 + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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 + +| Name | Summary | +|---|---| +| [notifyObservers](notify-observers.md) | `fun notifyObservers(block: `[`T`](index.md#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)
Notifies all registered observers about a change. | +| [pauseObserver](pause-observer.md) | `fun pauseObserver(observer: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Pauses the provided observer. No notifications will be sent to this observer until [resumeObserver](resume-observer.md) is called. | +| [register](register.md) | `fun register(observer: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
`fun register(observer: `[`T`](index.md#T)`, owner: LifecycleOwner, autoPause: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
`fun register(observer: `[`T`](index.md#T)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Registers an observer to get notified about changes. | +| [resumeObserver](resume-observer.md) | `fun resumeObserver(observer: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Resumes the provided observer. Notifications sent since it was last paused (see [pauseObserver](pause-observer.md)]) are lost and will not be re-delivered. | +| [unregister](unregister.md) | `fun unregister(observer: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Unregisters an observer. | +| [unregisterObservers](unregister-observers.md) | `fun unregisterObservers(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Unregisters all observers. | +| [wrapConsumers](wrap-consumers.md) | `fun wrapConsumers(block: `[`T`](index.md#T)`.(`[`V`](wrap-consumers.md#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.md#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/mozilla.components.support.base.observer/-observer-registry/notify-observers.md b/docs/api/mozilla.components.support.base.observer/-observer-registry/notify-observers.md new file mode 100644 index 00000000000..38f6c9378f0 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-observer-registry/notify-observers.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ObserverRegistry](index.md) / [notifyObservers](./notify-observers.md) + +# notifyObservers + +`fun notifyObservers(block: `[`T`](index.md#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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/ObserverRegistry.kt#L95) + +Overrides [Observable.notifyObservers](../-observable/notify-observers.md) + +Notifies all registered observers about a change. + +### Parameters + +`block` - the notification (method on the observer to be invoked). \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.observer/-observer-registry/pause-observer.md b/docs/api/mozilla.components.support.base.observer/-observer-registry/pause-observer.md new file mode 100644 index 00000000000..83d5755d24b --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-observer-registry/pause-observer.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ObserverRegistry](index.md) / [pauseObserver](./pause-observer.md) + +# pauseObserver + +`fun pauseObserver(observer: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/ObserverRegistry.kt#L83) + +Overrides [Observable.pauseObserver](../-observable/pause-observer.md) + +Pauses the provided observer. No notifications will be sent to this +observer until [resumeObserver](resume-observer.md) is called. + +### Parameters + +`observer` - the observer to pause. \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.observer/-observer-registry/register.md b/docs/api/mozilla.components.support.base.observer/-observer-registry/register.md new file mode 100644 index 00000000000..eff19a6b05a --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-observer-registry/register.md @@ -0,0 +1,42 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ObserverRegistry](index.md) / [register](./register.md) + +# register + +`fun register(observer: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/ObserverRegistry.kt#L24) + +Overrides [Observable.register](../-observable/register.md) + +Registers an observer to get notified about changes. + +### Parameters + +`observer` - the observer to register.`fun register(observer: `[`T`](index.md#T)`, owner: LifecycleOwner, autoPause: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/ObserverRegistry.kt#L30) + +Overrides [Observable.register](../-observable/register.md) + +Registers an observer to get notified about changes. + +The observer will automatically unsubscribe if the lifecycle of the provided LifecycleOwner +becomes DESTROYED. + +### Parameters + +`observer` - the observer to register. + +`owner` - the lifecycle owner the provided observer is bound to. + +`autoPause` - whether or not the observer should automatically be +paused/resumed with the bound lifecycle.`fun register(observer: `[`T`](index.md#T)`, view: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/ObserverRegistry.kt#L48) + +Overrides [Observable.register](../-observable/register.md) + +Registers an observer to get notified about changes. + +The observer will only be notified if the view is attached and will be unregistered/ +registered if the attached state changes. + +### Parameters + +`observer` - the observer to register. + +`view` - the view the provided observer is bound to. \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.observer/-observer-registry/resume-observer.md b/docs/api/mozilla.components.support.base.observer/-observer-registry/resume-observer.md new file mode 100644 index 00000000000..be0e3519564 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-observer-registry/resume-observer.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ObserverRegistry](index.md) / [resumeObserver](./resume-observer.md) + +# resumeObserver + +`fun resumeObserver(observer: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/ObserverRegistry.kt#L89) + +Overrides [Observable.resumeObserver](../-observable/resume-observer.md) + +Resumes the provided observer. Notifications sent since it +was last paused (see [pauseObserver](pause-observer.md)]) are lost and will not be +re-delivered. + +### Parameters + +`observer` - the observer to resume. \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.observer/-observer-registry/unregister-observers.md b/docs/api/mozilla.components.support.base.observer/-observer-registry/unregister-observers.md new file mode 100644 index 00000000000..30b943aa105 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-observer-registry/unregister-observers.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ObserverRegistry](index.md) / [unregisterObservers](./unregister-observers.md) + +# unregisterObservers + +`fun unregisterObservers(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/ObserverRegistry.kt#L73) + +Overrides [Observable.unregisterObservers](../-observable/unregister-observers.md) + +Unregisters all observers. + diff --git a/docs/api/mozilla.components.support.base.observer/-observer-registry/unregister.md b/docs/api/mozilla.components.support.base.observer/-observer-registry/unregister.md new file mode 100644 index 00000000000..bed62568a1a --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-observer-registry/unregister.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ObserverRegistry](index.md) / [unregister](./unregister.md) + +# unregister + +`fun unregister(observer: `[`T`](index.md#T)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/ObserverRegistry.kt#L63) + +Overrides [Observable.unregister](../-observable/unregister.md) + +Unregisters an observer. + +### Parameters + +`observer` - the observer to unregister. \ No newline at end of file diff --git a/docs/api/mozilla.components.support.base.observer/-observer-registry/wrap-consumers.md b/docs/api/mozilla.components.support.base.observer/-observer-registry/wrap-consumers.md new file mode 100644 index 00000000000..ff37c3117e2 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/-observer-registry/wrap-consumers.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.support.base.observer](../index.md) / [ObserverRegistry](index.md) / [wrapConsumers](./wrap-consumers.md) + +# wrapConsumers + +`fun wrapConsumers(block: `[`T`](index.md#T)`.(`[`V`](wrap-consumers.md#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.md#V)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/base/src/main/java/mozilla/components/support/base/observer/ObserverRegistry.kt#L105) + +Overrides [Observable.wrapConsumers](../-observable/wrap-consumers.md) + +Returns a list of lambdas wrapping a consuming method of an observer. + diff --git a/docs/api/mozilla.components.support.base.observer/index.md b/docs/api/mozilla.components.support.base.observer/index.md new file mode 100644 index 00000000000..dda01209570 --- /dev/null +++ b/docs/api/mozilla.components.support.base.observer/index.md @@ -0,0 +1,12 @@ +[android-components](../index.md) / [mozilla.components.support.base.observer](./index.md) + +## Package mozilla.components.support.base.observer + +### Types + +| Name | Summary | +|---|---| +| [Consumable](-consumable/index.md) | `class Consumable`
A generic wrapper for values that can get consumed. | +| [ConsumableStream](-consumable-stream/index.md) | `class ConsumableStream`
A generic wrapper for a stream of values that can be consumed. Values will be consumed first in, first out. | +| [Observable](-observable/index.md) | `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.md) | `class ObserverRegistry : `[`Observable`](-observable/index.md)`<`[`T`](-observer-registry/index.md#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/mozilla.components.support.ktx.android.arch.lifecycle/android.arch.lifecycle.-lifecycle/add-observers.md b/docs/api/mozilla.components.support.ktx.android.arch.lifecycle/android.arch.lifecycle.-lifecycle/add-observers.md new file mode 100644 index 00000000000..2d8e3cdbaa2 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.arch.lifecycle/android.arch.lifecycle.-lifecycle/add-observers.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.arch.lifecycle](../index.md) / [android.arch.lifecycle.Lifecycle](index.md) / [addObservers](./add-observers.md) + +# addObservers + +`fun Lifecycle.addObservers(vararg observers: LifecycleObserver): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/arch/lifecycle/Lifecycle.kt#L15) + +Calls [Lifecycle.addObserver](#) for a variable list of [LifecycleObserver](#)s. + diff --git a/docs/api/mozilla.components.support.ktx.android.arch.lifecycle/android.arch.lifecycle.-lifecycle/index.md b/docs/api/mozilla.components.support.ktx.android.arch.lifecycle/android.arch.lifecycle.-lifecycle/index.md new file mode 100644 index 00000000000..0fb554a1cf1 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.arch.lifecycle/android.arch.lifecycle.-lifecycle/index.md @@ -0,0 +1,7 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.arch.lifecycle](../index.md) / [android.arch.lifecycle.Lifecycle](./index.md) + +### Extensions for android.arch.lifecycle.Lifecycle + +| Name | Summary | +|---|---| +| [addObservers](add-observers.md) | `fun Lifecycle.addObservers(vararg observers: LifecycleObserver): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Calls [Lifecycle.addObserver](#) for a variable list of [LifecycleObserver](#)s. | diff --git a/docs/api/mozilla.components.support.ktx.android.arch.lifecycle/index.md b/docs/api/mozilla.components.support.ktx.android.arch.lifecycle/index.md new file mode 100644 index 00000000000..f49e994bd28 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.arch.lifecycle/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.support.ktx.android.arch.lifecycle](./index.md) + +## Package mozilla.components.support.ktx.android.arch.lifecycle + +### Extensions for External Classes + +| Name | Summary | +|---|---| +| [android.arch.lifecycle.Lifecycle](android.arch.lifecycle.-lifecycle/index.md) | | diff --git a/docs/api/mozilla.components.support.ktx.android.content.res/android.content.res.-asset-manager/index.md b/docs/api/mozilla.components.support.ktx.android.content.res/android.content.res.-asset-manager/index.md new file mode 100644 index 00000000000..c3541c09f0a --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.content.res/android.content.res.-asset-manager/index.md @@ -0,0 +1,7 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.content.res](../index.md) / [android.content.res.AssetManager](./index.md) + +### Extensions for android.content.res.AssetManager + +| Name | Summary | +|---|---| +| [readJSONObject](read-j-s-o-n-object.md) | `fun `[`AssetManager`](https://developer.android.com/reference/android/content/res/AssetManager.html)`.readJSONObject(fileName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)
Read a file from the "assets" and create a a JSONObject from its content. | diff --git a/docs/api/mozilla.components.support.ktx.android.content.res/android.content.res.-asset-manager/read-j-s-o-n-object.md b/docs/api/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..64cb0bce7d5 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.content.res/android.content.res.-asset-manager/read-j-s-o-n-object.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.content.res](../index.md) / [android.content.res.AssetManager](index.md) / [readJSONObject](./read-j-s-o-n-object.md) + +# readJSONObject + +`fun `[`AssetManager`](https://developer.android.com/reference/android/content/res/AssetManager.html)`.readJSONObject(fileName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/content/res/AssetManager.kt#L16) + +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/mozilla.components.support.ktx.android.content.res/android.content.res.-resources/index.md b/docs/api/mozilla.components.support.ktx.android.content.res/android.content.res.-resources/index.md new file mode 100644 index 00000000000..c28798e8a9c --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.content.res/android.content.res.-resources/index.md @@ -0,0 +1,7 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.content.res](../index.md) / [android.content.res.Resources](./index.md) + +### Extensions for android.content.res.Resources + +| Name | Summary | +|---|---| +| [pxToDp](px-to-dp.md) | `fun `[`Resources`](https://developer.android.com/reference/android/content/res/Resources.html)`.pxToDp(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 (pxToDp) to the actual pixel values for the display. | diff --git a/docs/api/mozilla.components.support.ktx.android.content.res/android.content.res.-resources/px-to-dp.md b/docs/api/mozilla.components.support.ktx.android.content.res/android.content.res.-resources/px-to-dp.md new file mode 100644 index 00000000000..d8b81cf52e5 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.content.res/android.content.res.-resources/px-to-dp.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.content.res](../index.md) / [android.content.res.Resources](index.md) / [pxToDp](./px-to-dp.md) + +# pxToDp + +`fun `[`Resources`](https://developer.android.com/reference/android/content/res/Resources.html)`.pxToDp(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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/content/res/Resources.kt#L9) + +Converts a value in density independent pixels (pxToDp) to the actual pixel values for the display. + diff --git a/docs/api/mozilla.components.support.ktx.android.content.res/index.md b/docs/api/mozilla.components.support.ktx.android.content.res/index.md new file mode 100644 index 00000000000..a7f9f114cb3 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.content.res/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.support.ktx.android.content.res](./index.md) + +## Package mozilla.components.support.ktx.android.content.res + +### Extensions for External Classes + +| Name | Summary | +|---|---| +| [android.content.res.AssetManager](android.content.res.-asset-manager/index.md) | | +| [android.content.res.Resources](android.content.res.-resources/index.md) | | diff --git a/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/app-version-name.md b/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/app-version-name.md new file mode 100644 index 00000000000..d28835c6bc4 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/app-version-name.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.content](../index.md) / [android.content.Context](index.md) / [appVersionName](./app-version-name.md) + +# appVersionName + +`val `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.appVersionName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/content/Context.kt#L24) + +The (visible) version name of the application, as specified by the tag's versionName +attribute. E.g. "2.0". + diff --git a/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/index.md b/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/index.md new file mode 100644 index 00000000000..ca7ca7b7d50 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/index.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.content](../index.md) / [android.content.Context](./index.md) + +### Extensions for android.content.Context + +| Name | Summary | +|---|---| +| [appVersionName](app-version-name.md) | `val `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.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". | +| [isOSOnLowMemory](is-o-s-on-low-memory.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.isOSOnLowMemory(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns whether or not the operating system is under low memory conditions. | +| [isPermissionGranted](is-permission-granted.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.isPermissionGranted(vararg permission: `[`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 if a list of permission have been granted, if all the permission have been granted returns true otherwise false. | +| [share](share.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.share(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, subject: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getString(R.string.mozac_support_ktx_share_dialog_title)): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Shares content via [ACTION_SEND](https://developer.android.com/reference/android/content/Intent.html#ACTION_SEND) intent. | +| [systemService](system-service.md) | `fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.systemService(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](system-service.md#T)
Returns the handle to a system-level service by name. | diff --git a/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/is-o-s-on-low-memory.md b/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/is-o-s-on-low-memory.md new file mode 100644 index 00000000000..999871cbd65 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/is-o-s-on-low-memory.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.content](../index.md) / [android.content.Context](index.md) / [isOSOnLowMemory](./is-o-s-on-low-memory.md) + +# isOSOnLowMemory + +`fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.isOSOnLowMemory(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/content/Context.kt#L40) + +Returns whether or not the operating system is under low memory conditions. + diff --git a/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/is-permission-granted.md b/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/is-permission-granted.md new file mode 100644 index 00000000000..9708b4daf60 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/is-permission-granted.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.content](../index.md) / [android.content.Context](index.md) / [isPermissionGranted](./is-permission-granted.md) + +# isPermissionGranted + +`fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.isPermissionGranted(vararg permission: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/content/Context.kt#L51) + +Returns if a list of permission have been granted, if all the permission have been granted +returns true otherwise false. + diff --git a/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/share.md b/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/share.md new file mode 100644 index 00000000000..ffebf100743 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/share.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.content](../index.md) / [android.content.Context](index.md) / [share](./share.md) + +# share + +`fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.share(text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, subject: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = getString(R.string.mozac_support_ktx_share_dialog_title)): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/content/Context.kt#L62) + +Shares content via [ACTION_SEND](https://developer.android.com/reference/android/content/Intent.html#ACTION_SEND) intent. + +### Parameters + +`text` - the data to be shared [EXTRA_TEXT](https://developer.android.com/reference/android/content/Intent.html#EXTRA_TEXT) + +`subject` - of the intent [EXTRA_TEXT](https://developer.android.com/reference/android/content/Intent.html#EXTRA_TEXT) + +**Return** +true it is able to share false otherwise. + diff --git a/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/system-service.md b/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/system-service.md new file mode 100644 index 00000000000..2e4ae7d775f --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.content/android.content.-context/system-service.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.content](../index.md) / [android.content.Context](index.md) / [systemService](./system-service.md) + +# systemService + +`inline fun `[`Context`](https://developer.android.com/reference/android/content/Context.html)`.systemService(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](system-service.md#T) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/content/Context.kt#L33) + +Returns the handle to a system-level service by name. + diff --git a/docs/api/mozilla.components.support.ktx.android.content/index.md b/docs/api/mozilla.components.support.ktx.android.content/index.md new file mode 100644 index 00000000000..0e819af5a4f --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.content/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.support.ktx.android.content](./index.md) + +## Package mozilla.components.support.ktx.android.content + +### Extensions for External Classes + +| Name | Summary | +|---|---| +| [android.content.Context](android.content.-context/index.md) | | diff --git a/docs/api/mozilla.components.support.ktx.android.graphics.drawable/android.graphics.drawable.-drawable/index.md b/docs/api/mozilla.components.support.ktx.android.graphics.drawable/android.graphics.drawable.-drawable/index.md new file mode 100644 index 00000000000..7f806351a3d --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.graphics.drawable/android.graphics.drawable.-drawable/index.md @@ -0,0 +1,7 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.graphics.drawable](../index.md) / [android.graphics.drawable.Drawable](./index.md) + +### Extensions for android.graphics.drawable.Drawable + +| Name | Summary | +|---|---| +| [toBitmap](to-bitmap.md) | `fun `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`.toBitmap(bitmapConfig: `[`Config`](https://developer.android.com/reference/android/graphics/Bitmap/Config.html)` = Bitmap.Config.ARGB_4444): `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)
Converts a Drawable to Bitmap. via https://stackoverflow.com/a/46018816/2219998. | diff --git a/docs/api/mozilla.components.support.ktx.android.graphics.drawable/android.graphics.drawable.-drawable/to-bitmap.md b/docs/api/mozilla.components.support.ktx.android.graphics.drawable/android.graphics.drawable.-drawable/to-bitmap.md new file mode 100644 index 00000000000..aa479ad716c --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.graphics.drawable/android.graphics.drawable.-drawable/to-bitmap.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.graphics.drawable](../index.md) / [android.graphics.drawable.Drawable](index.md) / [toBitmap](./to-bitmap.md) + +# toBitmap + +`@JvmOverloads fun `[`Drawable`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`.toBitmap(bitmapConfig: `[`Config`](https://developer.android.com/reference/android/graphics/Bitmap/Config.html)` = Bitmap.Config.ARGB_4444): `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/graphics/drawable/Drawable.kt#L16) + +Converts a Drawable to Bitmap. via https://stackoverflow.com/a/46018816/2219998. + diff --git a/docs/api/mozilla.components.support.ktx.android.graphics.drawable/index.md b/docs/api/mozilla.components.support.ktx.android.graphics.drawable/index.md new file mode 100644 index 00000000000..c88bbc05698 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.graphics.drawable/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.support.ktx.android.graphics.drawable](./index.md) + +## Package mozilla.components.support.ktx.android.graphics.drawable + +### Extensions for External Classes + +| Name | Summary | +|---|---| +| [android.graphics.drawable.Drawable](android.graphics.drawable.-drawable/index.md) | | diff --git a/docs/api/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/index.md b/docs/api/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/index.md new file mode 100644 index 00000000000..70bc2338c8a --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/index.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.graphics](../index.md) / [android.graphics.Bitmap](./index.md) + +### Extensions for android.graphics.Bitmap + +| Name | Summary | +|---|---| +| [toDataUri](to-data-uri.md) | `fun `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`.toDataUri(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Transform bitmap into base64 encoded data uri (PNG). | +| [withRoundedCorners](with-rounded-corners.md) | `fun `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`.withRoundedCorners(cornerRadiusPx: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`): `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)
Returns a new bitmap that is the receiver Bitmap with four rounded corners; the receiver is unmodified. | diff --git a/docs/api/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/to-data-uri.md b/docs/api/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/to-data-uri.md new file mode 100644 index 00000000000..3b277840570 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/to-data-uri.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.graphics](../index.md) / [android.graphics.Bitmap](index.md) / [toDataUri](./to-data-uri.md) + +# toDataUri + +`fun `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`.toDataUri(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/graphics/Bitmap.kt#L19) + +Transform bitmap into base64 encoded data uri (PNG). + diff --git a/docs/api/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/with-rounded-corners.md b/docs/api/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/with-rounded-corners.md new file mode 100644 index 00000000000..09690e95748 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/with-rounded-corners.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.graphics](../index.md) / [android.graphics.Bitmap](index.md) / [withRoundedCorners](./with-rounded-corners.md) + +# withRoundedCorners + +`@CheckResult fun `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html)`.withRoundedCorners(cornerRadiusPx: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`): `[`Bitmap`](https://developer.android.com/reference/android/graphics/Bitmap.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/graphics/Bitmap.kt#L36) + +Returns a new bitmap that is the receiver Bitmap with four rounded corners; +the receiver is unmodified. + +This operation is expensive: it requires allocating an identical Bitmap and copying +all of the Bitmap's pixels. Consider these theoretically cheaper alternatives: + +* android:background= a drawable with rounded corners +* Wrap your bitmap's ImageView with a layout that masks your view with rounded corners (e.g. CardView) diff --git a/docs/api/mozilla.components.support.ktx.android.graphics/index.md b/docs/api/mozilla.components.support.ktx.android.graphics/index.md new file mode 100644 index 00000000000..79b62f33891 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.graphics/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.support.ktx.android.graphics](./index.md) + +## Package mozilla.components.support.ktx.android.graphics + +### Extensions for External Classes + +| Name | Summary | +|---|---| +| [android.graphics.Bitmap](android.graphics.-bitmap/index.md) | | diff --git a/docs/api/mozilla.components.support.ktx.android.org.json/index.md b/docs/api/mozilla.components.support.ktx.android.org.json/index.md new file mode 100644 index 00000000000..8a38ce3a57f --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.org.json/index.md @@ -0,0 +1,11 @@ +[android-components](../index.md) / [mozilla.components.support.ktx.android.org.json](./index.md) + +## Package mozilla.components.support.ktx.android.org.json + +### Extensions for External Classes + +| Name | Summary | +|---|---| +| [kotlin.collections.Map](kotlin.collections.-map/index.md) | | +| [org.json.JSONArray](org.json.-j-s-o-n-array/index.md) | | +| [org.json.JSONObject](org.json.-j-s-o-n-object/index.md) | | diff --git a/docs/api/mozilla.components.support.ktx.android.org.json/kotlin.collections.-map/index.md b/docs/api/mozilla.components.support.ktx.android.org.json/kotlin.collections.-map/index.md new file mode 100644 index 00000000000..ea12ad4d8b7 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.org.json/kotlin.collections.-map/index.md @@ -0,0 +1,7 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.org.json](../index.md) / [kotlin.collections.Map](./index.md) + +### Extensions for kotlin.collections.Map + +| Name | Summary | +|---|---| +| [toJSON](to-j-s-o-n.md) | `fun `[`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)`>.toJSON(): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)
Convert a Map<String, String> to a JSONObject | diff --git a/docs/api/mozilla.components.support.ktx.android.org.json/kotlin.collections.-map/to-j-s-o-n.md b/docs/api/mozilla.components.support.ktx.android.org.json/kotlin.collections.-map/to-j-s-o-n.md new file mode 100644 index 00000000000..1ebb7c626c3 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.org.json/kotlin.collections.-map/to-j-s-o-n.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.org.json](../index.md) / [kotlin.collections.Map](index.md) / [toJSON](./to-j-s-o-n.md) + +# toJSON + +`fun `[`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)`>.toJSON(): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/org/json/JSONObject.kt#L73) + +Convert a Map<String, String> to a JSONObject + diff --git a/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/as-sequence.md b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/as-sequence.md new file mode 100644 index 00000000000..e38de3e7fbe --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/as-sequence.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.org.json](../index.md) / [org.json.JSONArray](index.md) / [asSequence](./as-sequence.md) + +# asSequence + +`fun `[`JSONArray`](https://developer.android.com/reference/org/json/JSONArray.html)`.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)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/org/json/JSONArray.kt#L12) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/index.md b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/index.md new file mode 100644 index 00000000000..ee43f1b3967 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/index.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.org.json](../index.md) / [org.json.JSONArray](./index.md) + +### Extensions for org.json.JSONArray + +| Name | Summary | +|---|---| +| [asSequence](as-sequence.md) | `fun `[`JSONArray`](https://developer.android.com/reference/org/json/JSONArray.html)`.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.md) | `fun `[`JSONArray`](https://developer.android.com/reference/org/json/JSONArray.html)`?.toList(): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`T`](to-list.md#T)`>`
Convenience method to convert a JSONArray into a List | diff --git a/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/to-list.md b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/to-list.md new file mode 100644 index 00000000000..6c6aea5f96d --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-array/to-list.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.org.json](../index.md) / [org.json.JSONArray](index.md) / [toList](./to-list.md) + +# toList + +`fun `[`JSONArray`](https://developer.android.com/reference/org/json/JSONArray.html)`?.toList(): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`T`](to-list.md#T)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/org/json/JSONArray.kt#L34) + +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/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/index.md b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/index.md new file mode 100644 index 00000000000..6725aa71082 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/index.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.org.json](../index.md) / [org.json.JSONObject](./index.md) + +### Extensions for org.json.JSONObject + +| Name | Summary | +|---|---| +| [mergeWith](merge-with.md) | `fun `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`.mergeWith(other: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Merge the contents of another [JSONObject](https://developer.android.com/reference/org/json/JSONObject.html) with this object, overwriting the colliding keys. | +| [putIfNotNull](put-if-not-null.md) | `fun `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`.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.md) | `fun `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`.sortKeys(): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)
Sorts the keys of a JSONObject (and all of its child JSONObjects) alphabetically | +| [tryGetInt](try-get-int.md) | `fun `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`.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.md) | `fun `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`.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.md) | `fun `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`.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/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/merge-with.md b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/merge-with.md new file mode 100644 index 00000000000..ed9daf3e6db --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/merge-with.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.org.json](../index.md) / [org.json.JSONObject](index.md) / [mergeWith](./merge-with.md) + +# mergeWith + +`fun `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`.mergeWith(other: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/org/json/JSONObject.kt#L84) + +Merge the contents of another [JSONObject](https://developer.android.com/reference/org/json/JSONObject.html) with this object, +overwriting the colliding keys. + +### Parameters + +`other` - the [JSONObject](https://developer.android.com/reference/org/json/JSONObject.html) providing the data to be + merged with this one. \ No newline at end of file diff --git a/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/put-if-not-null.md b/docs/api/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..e708083f392 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/put-if-not-null.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.org.json](../index.md) / [org.json.JSONObject](index.md) / [putIfNotNull](./put-if-not-null.md) + +# putIfNotNull + +`fun `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`.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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/org/json/JSONObject.kt#L46) + +Puts the specified value under the key if it's not null + diff --git a/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/sort-keys.md b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/sort-keys.md new file mode 100644 index 00000000000..df61106f3d9 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/sort-keys.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.org.json](../index.md) / [org.json.JSONObject](index.md) / [sortKeys](./sort-keys.md) + +# sortKeys + +`fun `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`.sortKeys(): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/org/json/JSONObject.kt#L55) + +Sorts the keys of a JSONObject (and all of its child JSONObjects) alphabetically + diff --git a/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-int.md b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-int.md new file mode 100644 index 00000000000..0a525b3e967 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-int.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.org.json](../index.md) / [org.json.JSONObject](index.md) / [tryGetInt](./try-get-int.md) + +# tryGetInt + +`fun `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`.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)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/org/json/JSONObject.kt#L25) + +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/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-long.md b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-long.md new file mode 100644 index 00000000000..11c5cf856bd --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-long.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.org.json](../index.md) / [org.json.JSONObject](index.md) / [tryGetLong](./try-get-long.md) + +# tryGetLong + +`fun `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`.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)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/org/json/JSONObject.kt#L36) + +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/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-string.md b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-string.md new file mode 100644 index 00000000000..782c5a5270e --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/try-get-string.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.org.json](../index.md) / [org.json.JSONObject](index.md) / [tryGetString](./try-get-string.md) + +# tryGetString + +`fun `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`.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)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/org/json/JSONObject.kt#L14) + +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/mozilla.components.support.ktx.android.os/android.os.-strict-mode.-thread-policy/index.md b/docs/api/mozilla.components.support.ktx.android.os/android.os.-strict-mode.-thread-policy/index.md new file mode 100644 index 00000000000..87892bbc588 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.os/android.os.-strict-mode.-thread-policy/index.md @@ -0,0 +1,7 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.os](../index.md) / [android.os.StrictMode.ThreadPolicy](./index.md) + +### Extensions for android.os.StrictMode.ThreadPolicy + +| Name | Summary | +|---|---| +| [resetAfter](reset-after.md) | `fun `[`ThreadPolicy`](https://developer.android.com/reference/android/os/StrictMode/ThreadPolicy.html)`.resetAfter(functionBlock: () -> `[`R`](reset-after.md#R)`): `[`R`](reset-after.md#R)
Runs the given [functionBlock](reset-after.md#mozilla.components.support.ktx.android.os$resetAfter(android.os.StrictMode.ThreadPolicy, kotlin.Function0((mozilla.components.support.ktx.android.os.resetAfter.R)))/functionBlock) and sets the ThreadPolicy after its completion. | diff --git a/docs/api/mozilla.components.support.ktx.android.os/android.os.-strict-mode.-thread-policy/reset-after.md b/docs/api/mozilla.components.support.ktx.android.os/android.os.-strict-mode.-thread-policy/reset-after.md new file mode 100644 index 00000000000..8450c6e0a90 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.os/android.os.-strict-mode.-thread-policy/reset-after.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.os](../index.md) / [android.os.StrictMode.ThreadPolicy](index.md) / [resetAfter](./reset-after.md) + +# resetAfter + +`inline fun `[`ThreadPolicy`](https://developer.android.com/reference/android/os/StrictMode/ThreadPolicy.html)`.resetAfter(functionBlock: () -> `[`R`](reset-after.md#R)`): `[`R`](reset-after.md#R) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/os/StrictMode.kt#L16) + +Runs the given [functionBlock](reset-after.md#mozilla.components.support.ktx.android.os$resetAfter(android.os.StrictMode.ThreadPolicy, kotlin.Function0((mozilla.components.support.ktx.android.os.resetAfter.R)))/functionBlock) and sets the ThreadPolicy after its completion. + +This function is written in the style of [AutoCloseable.use](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/use.html). + +**Return** +the value returned by [functionBlock](reset-after.md#mozilla.components.support.ktx.android.os$resetAfter(android.os.StrictMode.ThreadPolicy, kotlin.Function0((mozilla.components.support.ktx.android.os.resetAfter.R)))/functionBlock). + diff --git a/docs/api/mozilla.components.support.ktx.android.os/index.md b/docs/api/mozilla.components.support.ktx.android.os/index.md new file mode 100644 index 00000000000..12838bd7d79 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.os/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.support.ktx.android.os](./index.md) + +## Package mozilla.components.support.ktx.android.os + +### Extensions for External Classes + +| Name | Summary | +|---|---| +| [android.os.StrictMode.ThreadPolicy](android.os.-strict-mode.-thread-policy/index.md) | | diff --git a/docs/api/mozilla.components.support.ktx.android.util/-base64/encode-to-uri-string.md b/docs/api/mozilla.components.support.ktx.android.util/-base64/encode-to-uri-string.md new file mode 100644 index 00000000000..284e65fd6ab --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.util/-base64/encode-to-uri-string.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.util](../index.md) / [Base64](index.md) / [encodeToUriString](./encode-to-uri-string.md) + +# encodeToUriString + +`fun encodeToUriString(data: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/util/Base64.kt#L12) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.ktx.android.util/-base64/index.md b/docs/api/mozilla.components.support.ktx.android.util/-base64/index.md new file mode 100644 index 00000000000..b401976e184 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.util/-base64/index.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.util](../index.md) / [Base64](./index.md) + +# Base64 + +`object Base64` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/util/Base64.kt#L11) + +### Functions + +| Name | Summary | +|---|---| +| [encodeToUriString](encode-to-uri-string.md) | `fun encodeToUriString(data: `[`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/mozilla.components.support.ktx.android.util/index.md b/docs/api/mozilla.components.support.ktx.android.util/index.md new file mode 100644 index 00000000000..510beb30618 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.util/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.support.ktx.android.util](./index.md) + +## Package mozilla.components.support.ktx.android.util + +### Types + +| Name | Summary | +|---|---| +| [Base64](-base64/index.md) | `object Base64` | diff --git a/docs/api/mozilla.components.support.ktx.android.view/android.app.-activity/enter-to-immersive-mode.md b/docs/api/mozilla.components.support.ktx.android.view/android.app.-activity/enter-to-immersive-mode.md new file mode 100644 index 00000000000..626d040c399 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.view/android.app.-activity/enter-to-immersive-mode.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.view](../index.md) / [android.app.Activity](index.md) / [enterToImmersiveMode](./enter-to-immersive-mode.md) + +# enterToImmersiveMode + +`fun `[`Activity`](https://developer.android.com/reference/android/app/Activity.html)`.enterToImmersiveMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/view/Activity.kt#L16) + +Attempts to call immersive mode using the View to hide the status bar and navigation buttons. + diff --git a/docs/api/mozilla.components.support.ktx.android.view/android.app.-activity/exit-immersive-mode-if-needed.md b/docs/api/mozilla.components.support.ktx.android.view/android.app.-activity/exit-immersive-mode-if-needed.md new file mode 100644 index 00000000000..b6f90f0c581 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.view/android.app.-activity/exit-immersive-mode-if-needed.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.view](../index.md) / [android.app.Activity](index.md) / [exitImmersiveModeIfNeeded](./exit-immersive-mode-if-needed.md) + +# exitImmersiveModeIfNeeded + +`fun `[`Activity`](https://developer.android.com/reference/android/app/Activity.html)`.exitImmersiveModeIfNeeded(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/view/Activity.kt#L29) + +Attempts to come out from immersive mode using the View. + diff --git a/docs/api/mozilla.components.support.ktx.android.view/android.app.-activity/index.md b/docs/api/mozilla.components.support.ktx.android.view/android.app.-activity/index.md new file mode 100644 index 00000000000..72cd19644f7 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.view/android.app.-activity/index.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.view](../index.md) / [android.app.Activity](./index.md) + +### Extensions for android.app.Activity + +| Name | Summary | +|---|---| +| [enterToImmersiveMode](enter-to-immersive-mode.md) | `fun `[`Activity`](https://developer.android.com/reference/android/app/Activity.html)`.enterToImmersiveMode(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Attempts to call immersive mode using the View to hide the status bar and navigation buttons. | +| [exitImmersiveModeIfNeeded](exit-immersive-mode-if-needed.md) | `fun `[`Activity`](https://developer.android.com/reference/android/app/Activity.html)`.exitImmersiveModeIfNeeded(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Attempts to come out from immersive mode using the View. | diff --git a/docs/api/mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md new file mode 100644 index 00000000000..2459e3a1aa9 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.view](../index.md) / [android.view.ViewGroup](index.md) / [forEach](./for-each.md) + +# forEach + +`fun `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`.forEach(action: (`[`View`](https://developer.android.com/reference/android/view/View.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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/view/ViewGroup.kt#L13) + +Performs the given action on each View in this ViewGroup. + diff --git a/docs/api/mozilla.components.support.ktx.android.view/android.view.-view-group/index.md b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view-group/index.md new file mode 100644 index 00000000000..1dfca60a4c2 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view-group/index.md @@ -0,0 +1,7 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.view](../index.md) / [android.view.ViewGroup](./index.md) + +### Extensions for android.view.ViewGroup + +| Name | Summary | +|---|---| +| [forEach](for-each.md) | `fun `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`.forEach(action: (`[`View`](https://developer.android.com/reference/android/view/View.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 the given action on each View in this ViewGroup. | diff --git a/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md new file mode 100644 index 00000000000..84b8815e5a2 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.view](../index.md) / [android.view.View](index.md) / [hideKeyboard](./hide-keyboard.md) + +# hideKeyboard + +`fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.hideKeyboard(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/view/View.kt#L64) + +Hides the soft input window. + diff --git a/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/index.md b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/index.md new file mode 100644 index 00000000000..96fbb80344c --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/index.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.view](../index.md) / [android.view.View](./index.md) + +### Extensions for android.view.View + +| Name | Summary | +|---|---| +| [hideKeyboard](hide-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.hideKeyboard(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Hides the soft input window. | +| [isGone](is-gone.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [setPadding](set-padding.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.setPadding(padding: `[`Padding`](../../mozilla.components.support.base.android/-padding/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Set a padding using [Padding](../../mozilla.components.support.base.android/-padding/index.md) object. | +| [showKeyboard](show-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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/mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md new file mode 100644 index 00000000000..0334f9cb70c --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.view](../index.md) / [android.view.View](index.md) / [isGone](./is-gone.md) + +# isGone + +`fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.isGone(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/view/View.kt#L40) + +Returns true if this view's visibility is set to View.GONE. + diff --git a/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md new file mode 100644 index 00000000000..01722301565 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.view](../index.md) / [android.view.View](index.md) / [isInvisible](./is-invisible.md) + +# isInvisible + +`fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.isInvisible(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/view/View.kt#L47) + +Returns true if this view's visibility is set to View.INVISIBLE. + diff --git a/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md new file mode 100644 index 00000000000..7ebb25be7bf --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.view](../index.md) / [android.view.View](index.md) / [isLTR](./is-l-t-r.md) + +# isLTR + +`val `[`View`](https://developer.android.com/reference/android/view/View.html)`.isLTR: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/view/View.kt#L27) + +Is the horizontal layout direction of this view from Left to Right? + diff --git a/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md new file mode 100644 index 00000000000..4ab25dea718 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.view](../index.md) / [android.view.View](index.md) / [isRTL](./is-r-t-l.md) + +# isRTL + +`val `[`View`](https://developer.android.com/reference/android/view/View.html)`.isRTL: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/view/View.kt#L21) + +Is the horizontal layout direction of this view from Right to Left? + diff --git a/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md new file mode 100644 index 00000000000..289d0439f6c --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.view](../index.md) / [android.view.View](index.md) / [isVisible](./is-visible.md) + +# isVisible + +`fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.isVisible(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/view/View.kt#L33) + +Returns true if this view's visibility is set to View.VISIBLE. + diff --git a/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md new file mode 100644 index 00000000000..35f98cbcda6 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.view](../index.md) / [android.view.View](index.md) / [setPadding](./set-padding.md) + +# setPadding + +`fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.setPadding(padding: `[`Padding`](../../mozilla.components.support.base.android/-padding/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/view/View.kt#L74) + +Set a padding using [Padding](../../mozilla.components.support.base.android/-padding/index.md) object. + diff --git a/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md new file mode 100644 index 00000000000..6d3551468e0 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.android.view](../index.md) / [android.view.View](index.md) / [showKeyboard](./show-keyboard.md) + +# showKeyboard + +`fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/android/view/View.kt#L57) + +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/mozilla.components.support.ktx.android.view/index.md b/docs/api/mozilla.components.support.ktx.android.view/index.md new file mode 100644 index 00000000000..9dacf11337d --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.android.view/index.md @@ -0,0 +1,11 @@ +[android-components](../index.md) / [mozilla.components.support.ktx.android.view](./index.md) + +## Package mozilla.components.support.ktx.android.view + +### Extensions for External Classes + +| Name | Summary | +|---|---| +| [android.app.Activity](android.app.-activity/index.md) | | +| [android.view.View](android.view.-view/index.md) | | +| [android.view.ViewGroup](android.view.-view-group/index.md) | | diff --git a/docs/api/mozilla.components.support.ktx.kotlin/index.md b/docs/api/mozilla.components.support.ktx.kotlin/index.md new file mode 100644 index 00000000000..46acb123648 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.kotlin/index.md @@ -0,0 +1,11 @@ +[android-components](../index.md) / [mozilla.components.support.ktx.kotlin](./index.md) + +## Package mozilla.components.support.ktx.kotlin + +### Extensions for External Classes + +| Name | Summary | +|---|---| +| [kotlin.Char](kotlin.-char/index.md) | | +| [kotlin.String](kotlin.-string/index.md) | | +| [kotlin.collections.Map](kotlin.collections.-map/index.md) | | diff --git a/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-char/-e-l-l-i-p-s-i-s.md b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-char/-e-l-l-i-p-s-i-s.md new file mode 100644 index 00000000000..3380202769e --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-char/-e-l-l-i-p-s-i-s.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.kotlin](../index.md) / [kotlin.Char](index.md) / [ELLIPSIS](./-e-l-l-i-p-s-i-s.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/kotlin/Char.kt#L11) + +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/mozilla.components.support.ktx.kotlin/kotlin.-char/index.md b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-char/index.md new file mode 100644 index 00000000000..81810bd8ca9 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-char/index.md @@ -0,0 +1,7 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.kotlin](../index.md) / [kotlin.Char](./index.md) + +### Extensions for kotlin.Char + +| Name | Summary | +|---|---| +| [ELLIPSIS](-e-l-l-i-p-s-i-s.md) | `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/mozilla.components.support.ktx.kotlin/kotlin.-string/index.md b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/index.md new file mode 100644 index 00000000000..8915cd7a346 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/index.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.kotlin](../index.md) / [kotlin.String](./index.md) + +### Extensions for kotlin.String + +| Name | Summary | +|---|---| +| [isEmail](is-email.md) | `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.md) | `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.md) | `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.md) | `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. | +| [toDate](to-date.md) | `fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.toDate(format: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, locale: `[`Locale`](https://developer.android.com/reference/java/util/Locale.html)` = Locale.ROOT): `[`Date`](https://developer.android.com/reference/java/util/Date.html)
Converts a [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) to a [Date](https://developer.android.com/reference/java/util/Date.html) object. | +| [toNormalizedUrl](to-normalized-url.md) | `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/mozilla.components.support.ktx.kotlin/kotlin.-string/is-email.md b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/is-email.md new file mode 100644 index 00000000000..f66f48f787d --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/is-email.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.kotlin](../index.md) / [kotlin.String](index.md) / [isEmail](./is-email.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/kotlin/String.kt#L39) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/is-geo-location.md b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/is-geo-location.md new file mode 100644 index 00000000000..c1d4aa448da --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/is-geo-location.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.kotlin](../index.md) / [kotlin.String](index.md) / [isGeoLocation](./is-geo-location.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/kotlin/String.kt#L41) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/is-phone.md b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/is-phone.md new file mode 100644 index 00000000000..ff301e26843 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/is-phone.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.kotlin](../index.md) / [kotlin.String](index.md) / [isPhone](./is-phone.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/kotlin/String.kt#L37) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/is-url.md b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/is-url.md new file mode 100644 index 00000000000..4af8b28c7f6 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/is-url.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.kotlin](../index.md) / [kotlin.String](index.md) / [isUrl](./is-url.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/kotlin/String.kt#L28) + +Checks if this String is a URL. + diff --git a/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/to-date.md b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/to-date.md new file mode 100644 index 00000000000..23c16982d4f --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/to-date.md @@ -0,0 +1,18 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.kotlin](../index.md) / [kotlin.String](index.md) / [toDate](./to-date.md) + +# toDate + +`fun `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`.toDate(format: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, locale: `[`Locale`](https://developer.android.com/reference/java/util/Locale.html)` = Locale.ROOT): `[`Date`](https://developer.android.com/reference/java/util/Date.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/kotlin/String.kt#L50) + +Converts a [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) to a [Date](https://developer.android.com/reference/java/util/Date.html) object. + +### Parameters + +`format` - date format used for formatting the this given [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) object. + +`locale` - the locale to use when converting the String, defaults to [Locale.ROOT](https://developer.android.com/reference/java/util/Locale.html#ROOT). + +**Return** +a [Date](https://developer.android.com/reference/java/util/Date.html) object with the values in the provided in this string, if empty string was provided, a current date +will be returned. + diff --git a/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/to-normalized-url.md b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/to-normalized-url.md new file mode 100644 index 00000000000..ac40156ebff --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.-string/to-normalized-url.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.kotlin](../index.md) / [kotlin.String](index.md) / [toNormalizedUrl](./to-normalized-url.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/kotlin/String.kt#L16) + +Normalizes a URL String. + diff --git a/docs/api/mozilla.components.support.ktx.kotlin/kotlin.collections.-map/index.md b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.collections.-map/index.md new file mode 100644 index 00000000000..0e6755b2eb5 --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.collections.-map/index.md @@ -0,0 +1,7 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.kotlin](../index.md) / [kotlin.collections.Map](./index.md) + +### Extensions for kotlin.collections.Map + +| Name | Summary | +|---|---| +| [toBundle](to-bundle.md) | `fun `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`K`](to-bundle.md#K)`, `[`V`](to-bundle.md#V)`>.toBundle(): `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)
Converts a Map to a Bundle | diff --git a/docs/api/mozilla.components.support.ktx.kotlin/kotlin.collections.-map/to-bundle.md b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.collections.-map/to-bundle.md new file mode 100644 index 00000000000..6f2026ac46f --- /dev/null +++ b/docs/api/mozilla.components.support.ktx.kotlin/kotlin.collections.-map/to-bundle.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.ktx.kotlin](../index.md) / [kotlin.collections.Map](index.md) / [toBundle](./to-bundle.md) + +# toBundle + +`fun `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`K`](to-bundle.md#K)`, `[`V`](to-bundle.md#V)`>.toBundle(): `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/ktx/src/main/java/mozilla/components/support/ktx/kotlin/Map.kt#L18) + +Converts a Map to a Bundle + diff --git a/docs/api/mozilla.components.support.rustlog/-rust-log/disable.md b/docs/api/mozilla.components.support.rustlog/-rust-log/disable.md new file mode 100644 index 00000000000..481f18d9fcc --- /dev/null +++ b/docs/api/mozilla.components.support.rustlog/-rust-log/disable.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.rustlog](../index.md) / [RustLog](index.md) / [disable](./disable.md) + +# disable + +`fun disable(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/rustlog/src/main/java/mozilla/components/support/rustlog/RustLog.kt#L48) + +Disable the rust log adapter. + diff --git a/docs/api/mozilla.components.support.rustlog/-rust-log/enable.md b/docs/api/mozilla.components.support.rustlog/-rust-log/enable.md new file mode 100644 index 00000000000..cefdea597d9 --- /dev/null +++ b/docs/api/mozilla.components.support.rustlog/-rust-log/enable.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.support.rustlog](../index.md) / [RustLog](index.md) / [enable](./enable.md) + +# enable + +`fun enable(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/rustlog/src/main/java/mozilla/components/support/rustlog/RustLog.kt#L33) + +Enable the Rust log adapter. + +This does almost (see below) nothing if you are not in a megazord build. +After calling this, logs emitted by Rust code are forwarded to any +LogSinks attached to [Log](../../mozilla.components.support.base.log/-log/index.md). + +Megazording is required due to each dynamically loaded Rust library having +its own internal/private version of the Rust logging framework. When +megazording, this is still true, but there's only a single dynamically +loaded library, and so it is redirected properly. + +Note that non-megazord versions of the Rust libraries will log directly to +logcat by default (at DEBUG level), so while they cannot hook into the base +component log system, they still have logs available for development use. + +(We say "almost" nothing, as calling this will hook up logging for the dynamic +library containing the Rust log hooking (and only that), as well as logging +a single message indicating that it completed initialization). + diff --git a/docs/api/mozilla.components.support.rustlog/-rust-log/index.md b/docs/api/mozilla.components.support.rustlog/-rust-log/index.md new file mode 100644 index 00000000000..ac1012a109e --- /dev/null +++ b/docs/api/mozilla.components.support.rustlog/-rust-log/index.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.support.rustlog](../index.md) / [RustLog](./index.md) + +# RustLog + +`object RustLog` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/rustlog/src/main/java/mozilla/components/support/rustlog/RustLog.kt#L11) + +### Functions + +| Name | Summary | +|---|---| +| [disable](disable.md) | `fun disable(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Disable the rust log adapter. | +| [enable](enable.md) | `fun enable(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Enable the Rust log adapter. | +| [setMaxLevel](set-max-level.md) | `fun setMaxLevel(level: `[`Priority`](../../mozilla.components.support.base.log/-log/-priority/index.md)`, includePII: `[`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)
Set the maximum level of logs that will be forwarded to [Log](../../mozilla.components.support.base.log/-log/index.md). By default, the max level is DEBUG. | diff --git a/docs/api/mozilla.components.support.rustlog/-rust-log/set-max-level.md b/docs/api/mozilla.components.support.rustlog/-rust-log/set-max-level.md new file mode 100644 index 00000000000..e68b3652cbe --- /dev/null +++ b/docs/api/mozilla.components.support.rustlog/-rust-log/set-max-level.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [mozilla.components.support.rustlog](../index.md) / [RustLog](index.md) / [setMaxLevel](./set-max-level.md) + +# setMaxLevel + +`fun setMaxLevel(level: `[`Priority`](../../mozilla.components.support.base.log/-log/-priority/index.md)`, includePII: `[`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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/rustlog/src/main/java/mozilla/components/support/rustlog/RustLog.kt#L70) + +Set the maximum level of logs that will be forwarded to [Log](../../mozilla.components.support.base.log/-log/index.md). By +default, the max level is DEBUG. + +This is somewhat redundant with [Log.logLevel](../../mozilla.components.support.base.log/-log/log-level.md) (and a stricter +filter on Log.logLevel will take precedence here), however +setting the max level here can improve performance a great deal, +as it allows the Rust code to skip a great deal of work. + +This includes a `includePII` flag, which allows enabling logs at +the trace level. It is ignored if level is not [Log.Priority.DEBUG](../../mozilla.components.support.base.log/-log/-priority/-d-e-b-u-g.md). +These trace level logs* may contain the personal information of users +but can be very helpful for tracking down bugs. + +### Parameters + +`level` - The maximum (inclusive) level to include logs at. + +`includePII` - If `level` is [Log.Priority.DEBUG](../../mozilla.components.support.base.log/-log/-priority/-d-e-b-u-g.md), allow + debug logs to contain PII. \ No newline at end of file diff --git a/docs/api/mozilla.components.support.rustlog/index.md b/docs/api/mozilla.components.support.rustlog/index.md new file mode 100644 index 00000000000..61fad586450 --- /dev/null +++ b/docs/api/mozilla.components.support.rustlog/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.support.rustlog](./index.md) + +## Package mozilla.components.support.rustlog + +### Types + +| Name | Summary | +|---|---| +| [RustLog](-rust-log/index.md) | `object RustLog` | diff --git a/docs/api/mozilla.components.support.test.robolectric/grant-permission.md b/docs/api/mozilla.components.support.test.robolectric/grant-permission.md new file mode 100644 index 00000000000..cc1517ad35c --- /dev/null +++ b/docs/api/mozilla.components.support.test.robolectric/grant-permission.md @@ -0,0 +1,12 @@ +[android-components](../index.md) / [mozilla.components.support.test.robolectric](index.md) / [grantPermission](./grant-permission.md) + +# grantPermission + +`fun grantPermission(vararg permissions: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/test/src/main/java/mozilla/components/support/test/robolectric/Permissions.kt#L15) + +A helper for working with permission +just pass one or more permission that you need to be granted. + +### Parameters + +`permissions` - list of permissions that you need to be granted. \ No newline at end of file diff --git a/docs/api/mozilla.components.support.test.robolectric/index.md b/docs/api/mozilla.components.support.test.robolectric/index.md new file mode 100644 index 00000000000..f67b23e9481 --- /dev/null +++ b/docs/api/mozilla.components.support.test.robolectric/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.support.test.robolectric](./index.md) + +## Package mozilla.components.support.test.robolectric + +### Functions + +| Name | Summary | +|---|---| +| [grantPermission](grant-permission.md) | `fun grantPermission(vararg permissions: `[`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 helper for working with permission just pass one or more permission that you need to be granted. | diff --git a/docs/api/mozilla.components.support.test/-k-argument-captor/-init-.md b/docs/api/mozilla.components.support.test/-k-argument-captor/-init-.md new file mode 100644 index 00000000000..2e72b0e168b --- /dev/null +++ b/docs/api/mozilla.components.support.test/-k-argument-captor/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.test](../index.md) / [KArgumentCaptor](index.md) / [<init>](./-init-.md) + +# <init> + +`KArgumentCaptor(captor: ArgumentCaptor<`[`T`](index.md#T)`>, tClass: `[`KClass`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html)`<*>)` \ No newline at end of file diff --git a/docs/api/mozilla.components.support.test/-k-argument-captor/all-values.md b/docs/api/mozilla.components.support.test/-k-argument-captor/all-values.md new file mode 100644 index 00000000000..c2891f5cb21 --- /dev/null +++ b/docs/api/mozilla.components.support.test/-k-argument-captor/all-values.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.test](../index.md) / [KArgumentCaptor](index.md) / [allValues](./all-values.md) + +# allValues + +`val allValues: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`T`](index.md#T)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/test/src/main/java/mozilla/components/support/test/ArgumentCaptor.kt#L30) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.test/-k-argument-captor/capture.md b/docs/api/mozilla.components.support.test/-k-argument-captor/capture.md new file mode 100644 index 00000000000..a2c0265e545 --- /dev/null +++ b/docs/api/mozilla.components.support.test/-k-argument-captor/capture.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.test](../index.md) / [KArgumentCaptor](index.md) / [capture](./capture.md) + +# capture + +`fun capture(): `[`T`](index.md#T) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/test/src/main/java/mozilla/components/support/test/ArgumentCaptor.kt#L34) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.test/-k-argument-captor/index.md b/docs/api/mozilla.components.support.test/-k-argument-captor/index.md new file mode 100644 index 00000000000..b1526e96e6d --- /dev/null +++ b/docs/api/mozilla.components.support.test/-k-argument-captor/index.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [mozilla.components.support.test](../index.md) / [KArgumentCaptor](./index.md) + +# KArgumentCaptor + +`class KArgumentCaptor` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/test/src/main/java/mozilla/components/support/test/ArgumentCaptor.kt#L18) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `KArgumentCaptor(captor: ArgumentCaptor<`[`T`](index.md#T)`>, tClass: `[`KClass`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html)`<*>)` | + +### Properties + +| Name | Summary | +|---|---| +| [allValues](all-values.md) | `val allValues: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`T`](index.md#T)`>` | +| [value](value.md) | `val value: `[`T`](index.md#T)
The first captured value of the argument. | + +### Functions + +| Name | Summary | +|---|---| +| [capture](capture.md) | `fun capture(): `[`T`](index.md#T) | diff --git a/docs/api/mozilla.components.support.test/-k-argument-captor/value.md b/docs/api/mozilla.components.support.test/-k-argument-captor/value.md new file mode 100644 index 00000000000..20d76678618 --- /dev/null +++ b/docs/api/mozilla.components.support.test/-k-argument-captor/value.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.test](../index.md) / [KArgumentCaptor](index.md) / [value](./value.md) + +# value + +`val value: `[`T`](index.md#T) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/test/src/main/java/mozilla/components/support/test/ArgumentCaptor.kt#L27) + +The first captured value of the argument. + +### Exceptions + +`IndexOutOfBoundsException` - if the value is not available. \ No newline at end of file diff --git a/docs/api/mozilla.components.support.test/any.md b/docs/api/mozilla.components.support.test/any.md new file mode 100644 index 00000000000..cedbbdddd12 --- /dev/null +++ b/docs/api/mozilla.components.support.test/any.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.support.test](index.md) / [any](./any.md) + +# any + +`fun any(): `[`T`](any.md#T) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/test/src/main/java/mozilla/components/support/test/Matchers.kt#L14) + +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/mozilla.components.support.test/argument-captor.md b/docs/api/mozilla.components.support.test/argument-captor.md new file mode 100644 index 00000000000..b0022a6fa38 --- /dev/null +++ b/docs/api/mozilla.components.support.test/argument-captor.md @@ -0,0 +1,8 @@ +[android-components](../index.md) / [mozilla.components.support.test](index.md) / [argumentCaptor](./argument-captor.md) + +# argumentCaptor + +`inline fun argumentCaptor(): `[`KArgumentCaptor`](-k-argument-captor/index.md)`<`[`T`](argument-captor.md#T)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/test/src/main/java/mozilla/components/support/test/ArgumentCaptor.kt#L15) + +Creates a [KArgumentCaptor](-k-argument-captor/index.md) for given type. + diff --git a/docs/api/mozilla.components.support.test/create-instance.md b/docs/api/mozilla.components.support.test/create-instance.md new file mode 100644 index 00000000000..1f7d91f101e --- /dev/null +++ b/docs/api/mozilla.components.support.test/create-instance.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.support.test](index.md) / [createInstance](./create-instance.md) + +# createInstance + +`fun createInstance(kClass: `[`KClass`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html)`<`[`T`](create-instance.md#T)`>): `[`T`](create-instance.md#T) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/test/src/main/java/mozilla/components/support/test/ArgumentCaptor.kt#L39) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.test/eq.md b/docs/api/mozilla.components.support.test/eq.md new file mode 100644 index 00000000000..8174a7d7ced --- /dev/null +++ b/docs/api/mozilla.components.support.test/eq.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.support.test](index.md) / [eq](./eq.md) + +# eq + +`fun eq(value: `[`T`](eq.md#T)`): `[`T`](eq.md#T) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/test/src/main/java/mozilla/components/support/test/Matchers.kt#L24) + +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/mozilla.components.support.test/expect-exception.md b/docs/api/mozilla.components.support.test/expect-exception.md new file mode 100644 index 00000000000..db2d0de1067 --- /dev/null +++ b/docs/api/mozilla.components.support.test/expect-exception.md @@ -0,0 +1,8 @@ +[android-components](../index.md) / [mozilla.components.support.test](index.md) / [expectException](./expect-exception.md) + +# expectException + +`inline fun expectException(clazz: `[`KClass`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html)`<`[`T`](expect-exception.md#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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/test/src/main/java/mozilla/components/support/test/Expect.kt#L13) + +Expect [block](expect-exception.md#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/mozilla.components.support.test/index.md b/docs/api/mozilla.components.support.test/index.md new file mode 100644 index 00000000000..ceaa353e6da --- /dev/null +++ b/docs/api/mozilla.components.support.test/index.md @@ -0,0 +1,21 @@ +[android-components](../index.md) / [mozilla.components.support.test](./index.md) + +## Package mozilla.components.support.test + +### Types + +| Name | Summary | +|---|---| +| [KArgumentCaptor](-k-argument-captor/index.md) | `class KArgumentCaptor` | + +### Functions + +| Name | Summary | +|---|---| +| [any](any.md) | `fun any(): `[`T`](any.md#T)
Mockito matcher that matches anything, including nulls and varargs. | +| [argumentCaptor](argument-captor.md) | `fun argumentCaptor(): `[`KArgumentCaptor`](-k-argument-captor/index.md)`<`[`T`](argument-captor.md#T)`>`
Creates a [KArgumentCaptor](-k-argument-captor/index.md) for given type. | +| [createInstance](create-instance.md) | `fun createInstance(kClass: `[`KClass`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html)`<`[`T`](create-instance.md#T)`>): `[`T`](create-instance.md#T) | +| [eq](eq.md) | `fun eq(value: `[`T`](eq.md#T)`): `[`T`](eq.md#T)
Mockito matcher that matches if the argument is the same as the provided value. | +| [expectException](expect-exception.md) | `fun expectException(clazz: `[`KClass`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html)`<`[`T`](expect-exception.md#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.md#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.md) | `fun mock(): `[`T`](mock.md#T)
Dynamically create a mock object. This method is helpful when creating mocks of classes using generics. | +| [mockMotionEvent](mock-motion-event.md) | `fun mockMotionEvent(action: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, downTime: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = System.currentTimeMillis(), eventTime: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = System.currentTimeMillis(), x: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)` = 0f, y: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)` = 0f, metaState: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0): `[`MotionEvent`](https://developer.android.com/reference/android/view/MotionEvent.html)
Creates a custom [MotionEvent](https://developer.android.com/reference/android/view/MotionEvent.html) for testing. As of SDK 28 [MotionEvent](https://developer.android.com/reference/android/view/MotionEvent.html)s can't be mocked anymore and need to be created through [MotionEvent.obtain](https://developer.android.com/reference/android/view/MotionEvent.html#obtain(long, long, int, int, android.view.MotionEvent.PointerProperties[], android.view.MotionEvent.PointerCoords[], int, int, float, float, int, int, int, int)). | diff --git a/docs/api/mozilla.components.support.test/mock-motion-event.md b/docs/api/mozilla.components.support.test/mock-motion-event.md new file mode 100644 index 00000000000..d28f4d42f8e --- /dev/null +++ b/docs/api/mozilla.components.support.test/mock-motion-event.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.support.test](index.md) / [mockMotionEvent](./mock-motion-event.md) + +# mockMotionEvent + +`fun mockMotionEvent(action: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, downTime: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = System.currentTimeMillis(), eventTime: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` = System.currentTimeMillis(), x: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)` = 0f, y: `[`Float`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)` = 0f, metaState: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0): `[`MotionEvent`](https://developer.android.com/reference/android/view/MotionEvent.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/test/src/main/java/mozilla/components/support/test/Mock.kt#L26) + +Creates a custom [MotionEvent](https://developer.android.com/reference/android/view/MotionEvent.html) for testing. As of SDK 28 [MotionEvent](https://developer.android.com/reference/android/view/MotionEvent.html)s can't be mocked anymore and need to be created +through [MotionEvent.obtain](https://developer.android.com/reference/android/view/MotionEvent.html#obtain(long, long, int, int, android.view.MotionEvent.PointerProperties[], android.view.MotionEvent.PointerCoords[], int, int, float, float, int, int, int, int)). + diff --git a/docs/api/mozilla.components.support.test/mock.md b/docs/api/mozilla.components.support.test/mock.md new file mode 100644 index 00000000000..f33e52466db --- /dev/null +++ b/docs/api/mozilla.components.support.test/mock.md @@ -0,0 +1,15 @@ +[android-components](../index.md) / [mozilla.components.support.test](index.md) / [mock](./mock.md) + +# mock + +`inline fun mock(): `[`T`](mock.md#T) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/test/src/main/java/mozilla/components/support/test/Mock.kt#L20) + +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/mozilla.components.support.utils/-color-utils/get-readable-text-color.md b/docs/api/mozilla.components.support.utils/-color-utils/get-readable-text-color.md new file mode 100644 index 00000000000..06b83282d42 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-color-utils/get-readable-text-color.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [ColorUtils](index.md) / [getReadableTextColor](./get-readable-text-color.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/ColorUtils.kt#L14) + +Get text color (white or black) that is readable on top of the provided background color. + diff --git a/docs/api/mozilla.components.support.utils/-color-utils/index.md b/docs/api/mozilla.components.support.utils/-color-utils/index.md new file mode 100644 index 00000000000..10f03d9c1f4 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-color-utils/index.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [ColorUtils](./index.md) + +# ColorUtils + +`object ColorUtils` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/ColorUtils.kt#L9) + +### Functions + +| Name | Summary | +|---|---| +| [getReadableTextColor](get-readable-text-color.md) | `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/mozilla.components.support.utils/-domain-match/-init-.md b/docs/api/mozilla.components.support.utils/-domain-match/-init-.md new file mode 100644 index 00000000000..f278e568afd --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-domain-match/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [DomainMatch](index.md) / [<init>](./-init-.md) + +# <init> + +`DomainMatch(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, matchedSegment: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-domain-match/index.md b/docs/api/mozilla.components.support.utils/-domain-match/index.md new file mode 100644 index 00000000000..16738770177 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-domain-match/index.md @@ -0,0 +1,18 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [DomainMatch](./index.md) + +# DomainMatch + +`data class DomainMatch` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/DomainMatcher.kt#L11) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `DomainMatch(url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, matchedSegment: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` | + +### Properties + +| Name | Summary | +|---|---| +| [matchedSegment](matched-segment.md) | `val matchedSegment: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [url](url.md) | `val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/mozilla.components.support.utils/-domain-match/matched-segment.md b/docs/api/mozilla.components.support.utils/-domain-match/matched-segment.md new file mode 100644 index 00000000000..c7d1561b4b0 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-domain-match/matched-segment.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [DomainMatch](index.md) / [matchedSegment](./matched-segment.md) + +# matchedSegment + +`val matchedSegment: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/DomainMatcher.kt#L11) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-domain-match/url.md b/docs/api/mozilla.components.support.utils/-domain-match/url.md new file mode 100644 index 00000000000..6aa8911e3b0 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-domain-match/url.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [DomainMatch](index.md) / [url](./url.md) + +# url + +`val url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/DomainMatcher.kt#L11) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-download-utils/guess-file-name.md b/docs/api/mozilla.components.support.utils/-download-utils/guess-file-name.md new file mode 100644 index 00000000000..50457108bf4 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-download-utils/guess-file-name.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [DownloadUtils](index.md) / [guessFileName](./guess-file-name.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/DownloadUtils.kt#L62) + +Guess the name of the file that should be downloaded. + +This method is largely identical to [android.webkit.URLUtil.guessFileName](https://developer.android.com/reference/android/webkit/URLUtil.html#guessFileName(java.lang.String, java.lang.String, java.lang.String)) +which unfortunately does not implement RfC 5987. + diff --git a/docs/api/mozilla.components.support.utils/-download-utils/index.md b/docs/api/mozilla.components.support.utils/-download-utils/index.md new file mode 100644 index 00000000000..b0d8f83423e --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-download-utils/index.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [DownloadUtils](./index.md) + +# DownloadUtils + +`object DownloadUtils` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/DownloadUtils.kt#L31) + +### Functions + +| Name | Summary | +|---|---| +| [guessFileName](guess-file-name.md) | `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/mozilla.components.support.utils/-drawable-utils/index.md b/docs/api/mozilla.components.support.utils/-drawable-utils/index.md new file mode 100644 index 00000000000..53f76132f42 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-drawable-utils/index.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [DrawableUtils](./index.md) + +# DrawableUtils + +`object DrawableUtils` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/DrawableUtils.kt#L13) + +### Functions + +| Name | Summary | +|---|---| +| [loadAndTintDrawable](load-and-tint-drawable.md) | `fun loadAndTintDrawable(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, 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`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)
Return a tinted drawable object associated with a particular resource ID. | diff --git a/docs/api/mozilla.components.support.utils/-drawable-utils/load-and-tint-drawable.md b/docs/api/mozilla.components.support.utils/-drawable-utils/load-and-tint-drawable.md new file mode 100644 index 00000000000..8810a959781 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-drawable-utils/load-and-tint-drawable.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [DrawableUtils](index.md) / [loadAndTintDrawable](./load-and-tint-drawable.md) + +# loadAndTintDrawable + +`fun loadAndTintDrawable(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, @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`](https://developer.android.com/reference/android/graphics/drawable/Drawable.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/DrawableUtils.kt#L17) + +Return a tinted drawable object associated with a particular resource ID. + diff --git a/docs/api/mozilla.components.support.utils/-safe-bundle/-init-.md b/docs/api/mozilla.components.support.utils/-safe-bundle/-init-.md new file mode 100644 index 00000000000..01d8cb088c3 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-bundle/-init-.md @@ -0,0 +1,12 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeBundle](index.md) / [<init>](./-init-.md) + +# <init> + +`SafeBundle(bundle: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.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. + +See bug 1090385 for more. + diff --git a/docs/api/mozilla.components.support.utils/-safe-bundle/get-parcelable.md b/docs/api/mozilla.components.support.utils/-safe-bundle/get-parcelable.md new file mode 100644 index 00000000000..6640d66a37a --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-bundle/get-parcelable.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeBundle](index.md) / [getParcelable](./get-parcelable.md) + +# getParcelable + +`fun getParcelable(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](get-parcelable.md#T)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeBundle.kt#L32) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-bundle/get-string.md b/docs/api/mozilla.components.support.utils/-safe-bundle/get-string.md new file mode 100644 index 00000000000..d4e1aaaa0d1 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-bundle/get-string.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeBundle](index.md) / [getString](./get-string.md) + +# 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)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeBundle.kt#L20) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-bundle/index.md b/docs/api/mozilla.components.support.utils/-safe-bundle/index.md new file mode 100644 index 00000000000..97d4d9d9fe3 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-bundle/index.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeBundle](./index.md) + +# SafeBundle + +`class SafeBundle` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeBundle.kt#L18) + +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 + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SafeBundle(bundle: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.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. | + +### Functions + +| Name | Summary | +|---|---| +| [getParcelable](get-parcelable.md) | `fun getParcelable(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](get-parcelable.md#T)`?` | +| [getString](get-string.md) | `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/mozilla.components.support.utils/-safe-intent/-init-.md b/docs/api/mozilla.components.support.utils/-safe-intent/-init-.md new file mode 100644 index 00000000000..c94ac31db00 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/-init-.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [<init>](./-init-.md) + +# <init> + +`SafeIntent(unsafe: `[`Intent`](https://developer.android.com/reference/android/content/Intent.html)`)` + +External applications can pass values into Intents that can cause us to crash: in defense, +we wrap [Intent](https://developer.android.com/reference/android/content/Intent.html) and catch the exceptions they may force us to throw. See bug 1090385 +for more. + diff --git a/docs/api/mozilla.components.support.utils/-safe-intent/action.md b/docs/api/mozilla.components.support.utils/-safe-intent/action.md new file mode 100644 index 00000000000..d4570a2bdf9 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/action.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [action](./action.md) + +# action + +`val action: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L24) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-intent/categories.md b/docs/api/mozilla.components.support.utils/-safe-intent/categories.md new file mode 100644 index 00000000000..a959cc36e73 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/categories.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [categories](./categories.md) + +# 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)`>?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L42) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-intent/data-string.md b/docs/api/mozilla.components.support.utils/-safe-intent/data-string.md new file mode 100644 index 00000000000..a0e3f6c3996 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/data-string.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [dataString](./data-string.md) + +# dataString + +`val dataString: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L36) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-intent/data.md b/docs/api/mozilla.components.support.utils/-safe-intent/data.md new file mode 100644 index 00000000000..61ff8e82685 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/data.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [data](./data.md) + +# data + +`val data: `[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L39) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-intent/extras.md b/docs/api/mozilla.components.support.utils/-safe-intent/extras.md new file mode 100644 index 00000000000..2a2590a6d90 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/extras.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [extras](./extras.md) + +# extras + +`val extras: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L21) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-intent/flags.md b/docs/api/mozilla.components.support.utils/-safe-intent/flags.md new file mode 100644 index 00000000000..c2d0598ab1a --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/flags.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [flags](./flags.md) + +# flags + +`val flags: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L27) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-intent/get-boolean-extra.md b/docs/api/mozilla.components.support.utils/-safe-intent/get-boolean-extra.md new file mode 100644 index 00000000000..5e9785043a2 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/get-boolean-extra.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [getBooleanExtra](./get-boolean-extra.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L49) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-intent/get-bundle-extra.md b/docs/api/mozilla.components.support.utils/-safe-intent/get-bundle-extra.md new file mode 100644 index 00000000000..f836685f690 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/get-bundle-extra.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [getBundleExtra](./get-bundle-extra.md) + +# getBundleExtra + +`fun getBundleExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`SafeBundle`](../-safe-bundle/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L61) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-intent/get-char-sequence-extra.md b/docs/api/mozilla.components.support.utils/-safe-intent/get-char-sequence-extra.md new file mode 100644 index 00000000000..7ae2c0a8d90 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/get-char-sequence-extra.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [getCharSequenceExtra](./get-char-sequence-extra.md) + +# 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)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L70) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-intent/get-int-extra.md b/docs/api/mozilla.components.support.utils/-safe-intent/get-int-extra.md new file mode 100644 index 00000000000..1f19f485359 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/get-int-extra.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [getIntExtra](./get-int-extra.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L53) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-intent/get-parcelable-array-list-extra.md b/docs/api/mozilla.components.support.utils/-safe-intent/get-parcelable-array-list-extra.md new file mode 100644 index 00000000000..c5267afdba7 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/get-parcelable-array-list-extra.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [getParcelableArrayListExtra](./get-parcelable-array-list-extra.md) + +# getParcelableArrayListExtra + +`fun getParcelableArrayListExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`ArrayList`](https://developer.android.com/reference/java/util/ArrayList.html)`<`[`T`](get-parcelable-array-list-extra.md#T)`>?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L78) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-intent/get-parcelable-extra.md b/docs/api/mozilla.components.support.utils/-safe-intent/get-parcelable-extra.md new file mode 100644 index 00000000000..812d7ff2906 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/get-parcelable-extra.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [getParcelableExtra](./get-parcelable-extra.md) + +# getParcelableExtra + +`fun getParcelableExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](get-parcelable-extra.md#T)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L74) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-intent/get-string-array-list-extra.md b/docs/api/mozilla.components.support.utils/-safe-intent/get-string-array-list-extra.md new file mode 100644 index 00000000000..6c42bd5d215 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/get-string-array-list-extra.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [getStringArrayListExtra](./get-string-array-list-extra.md) + +# getStringArrayListExtra + +`fun getStringArrayListExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`ArrayList`](https://developer.android.com/reference/java/util/ArrayList.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L85) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-intent/get-string-extra.md b/docs/api/mozilla.components.support.utils/-safe-intent/get-string-extra.md new file mode 100644 index 00000000000..66efcd6d16a --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/get-string-extra.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [getStringExtra](./get-string-extra.md) + +# 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)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L57) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-intent/has-extra.md b/docs/api/mozilla.components.support.utils/-safe-intent/has-extra.md new file mode 100644 index 00000000000..24638689269 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/has-extra.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [hasExtra](./has-extra.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L45) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-intent/index.md b/docs/api/mozilla.components.support.utils/-safe-intent/index.md new file mode 100644 index 00000000000..99f5ec1ea43 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/index.md @@ -0,0 +1,42 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](./index.md) + +# SafeIntent + +`class SafeIntent` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L20) + +External applications can pass values into Intents that can cause us to crash: in defense, +we wrap [Intent](https://developer.android.com/reference/android/content/Intent.html) and catch the exceptions they may force us to throw. See bug 1090385 +for more. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SafeIntent(unsafe: `[`Intent`](https://developer.android.com/reference/android/content/Intent.html)`)`
External applications can pass values into Intents that can cause us to crash: in defense, we wrap [Intent](https://developer.android.com/reference/android/content/Intent.html) and catch the exceptions they may force us to throw. See bug 1090385 for more. | + +### Properties + +| Name | Summary | +|---|---| +| [action](action.md) | `val action: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [categories](categories.md) | `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.md) | `val data: `[`Uri`](https://developer.android.com/reference/android/net/Uri.html)`?` | +| [dataString](data-string.md) | `val dataString: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` | +| [extras](extras.md) | `val extras: `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`?` | +| [flags](flags.md) | `val flags: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [isLauncherIntent](is-launcher-intent.md) | `val isLauncherIntent: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [unsafe](unsafe.md) | `val unsafe: `[`Intent`](https://developer.android.com/reference/android/content/Intent.html) | + +### Functions + +| Name | Summary | +|---|---| +| [getBooleanExtra](get-boolean-extra.md) | `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.md) | `fun getBundleExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`SafeBundle`](../-safe-bundle/index.md)`?` | +| [getCharSequenceExtra](get-char-sequence-extra.md) | `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.md) | `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.md) | `fun getParcelableArrayListExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`ArrayList`](https://developer.android.com/reference/java/util/ArrayList.html)`<`[`T`](get-parcelable-array-list-extra.md#T)`>?` | +| [getParcelableExtra](get-parcelable-extra.md) | `fun getParcelableExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`T`](get-parcelable-extra.md#T)`?` | +| [getStringArrayListExtra](get-string-array-list-extra.md) | `fun getStringArrayListExtra(name: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`ArrayList`](https://developer.android.com/reference/java/util/ArrayList.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>?` | +| [getStringExtra](get-string-extra.md) | `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.md) | `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/mozilla.components.support.utils/-safe-intent/is-launcher-intent.md b/docs/api/mozilla.components.support.utils/-safe-intent/is-launcher-intent.md new file mode 100644 index 00000000000..d009a4a9de4 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/is-launcher-intent.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [isLauncherIntent](./is-launcher-intent.md) + +# isLauncherIntent + +`val isLauncherIntent: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L30) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-safe-intent/unsafe.md b/docs/api/mozilla.components.support.utils/-safe-intent/unsafe.md new file mode 100644 index 00000000000..a7f4b526e5e --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-safe-intent/unsafe.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [SafeIntent](index.md) / [unsafe](./unsafe.md) + +# unsafe + +`val unsafe: `[`Intent`](https://developer.android.com/reference/android/content/Intent.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/SafeIntent.kt#L20) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-status-bar-utils/get-status-bar-height.md b/docs/api/mozilla.components.support.utils/-status-bar-utils/get-status-bar-height.md new file mode 100644 index 00000000000..5105f8785cd --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-status-bar-utils/get-status-bar-height.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [StatusBarUtils](index.md) / [getStatusBarHeight](./get-status-bar-height.md) + +# getStatusBarHeight + +`fun getStatusBarHeight(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/StatusBarUtils.kt#L15) + +Determine the height of the status bar asynchronously. + diff --git a/docs/api/mozilla.components.support.utils/-status-bar-utils/index.md b/docs/api/mozilla.components.support.utils/-status-bar-utils/index.md new file mode 100644 index 00000000000..890bae3ecad --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-status-bar-utils/index.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [StatusBarUtils](./index.md) + +# StatusBarUtils + +`object StatusBarUtils` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/StatusBarUtils.kt#L9) + +### Functions + +| Name | Summary | +|---|---| +| [getStatusBarHeight](get-status-bar-height.md) | `fun getStatusBarHeight(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`, 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/mozilla.components.support.utils/-thread-utils/assert-on-ui-thread.md b/docs/api/mozilla.components.support.utils/-thread-utils/assert-on-ui-thread.md new file mode 100644 index 00000000000..c49a09b3dd5 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-thread-utils/assert-on-ui-thread.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [ThreadUtils](index.md) / [assertOnUiThread](./assert-on-ui-thread.md) + +# assertOnUiThread + +`fun assertOnUiThread(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/ThreadUtils.kt#L48) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-thread-utils/index.md b/docs/api/mozilla.components.support.utils/-thread-utils/index.md new file mode 100644 index 00000000000..a8a705aee28 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-thread-utils/index.md @@ -0,0 +1,15 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [ThreadUtils](./index.md) + +# ThreadUtils + +`object ThreadUtils` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/ThreadUtils.kt#L11) + +### Functions + +| Name | Summary | +|---|---| +| [assertOnUiThread](assert-on-ui-thread.md) | `fun assertOnUiThread(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [postToBackgroundThread](post-to-background-thread.md) | `fun postToBackgroundThread(runnable: `[`Runnable`](https://developer.android.com/reference/java/lang/Runnable.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
`fun postToBackgroundThread(runnable: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [postToMainThread](post-to-main-thread.md) | `fun postToMainThread(runnable: `[`Runnable`](https://developer.android.com/reference/java/lang/Runnable.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [postToMainThreadDelayed](post-to-main-thread-delayed.md) | `fun postToMainThreadDelayed(runnable: `[`Runnable`](https://developer.android.com/reference/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) | +| [setHandlerForTest](set-handler-for-test.md) | `fun setHandlerForTest(handler: `[`Handler`](https://developer.android.com/reference/android/os/Handler.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.support.utils/-thread-utils/post-to-background-thread.md b/docs/api/mozilla.components.support.utils/-thread-utils/post-to-background-thread.md new file mode 100644 index 00000000000..d996966dcef --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-thread-utils/post-to-background-thread.md @@ -0,0 +1,6 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [ThreadUtils](index.md) / [postToBackgroundThread](./post-to-background-thread.md) + +# postToBackgroundThread + +`fun postToBackgroundThread(runnable: `[`Runnable`](https://developer.android.com/reference/java/lang/Runnable.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/ThreadUtils.kt#L32) +`fun postToBackgroundThread(runnable: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/ThreadUtils.kt#L36) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-thread-utils/post-to-main-thread-delayed.md b/docs/api/mozilla.components.support.utils/-thread-utils/post-to-main-thread-delayed.md new file mode 100644 index 00000000000..8a54d99a5ec --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-thread-utils/post-to-main-thread-delayed.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [ThreadUtils](index.md) / [postToMainThreadDelayed](./post-to-main-thread-delayed.md) + +# postToMainThreadDelayed + +`fun postToMainThreadDelayed(runnable: `[`Runnable`](https://developer.android.com/reference/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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/ThreadUtils.kt#L44) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-thread-utils/post-to-main-thread.md b/docs/api/mozilla.components.support.utils/-thread-utils/post-to-main-thread.md new file mode 100644 index 00000000000..4374b25abe7 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-thread-utils/post-to-main-thread.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [ThreadUtils](index.md) / [postToMainThread](./post-to-main-thread.md) + +# postToMainThread + +`fun postToMainThread(runnable: `[`Runnable`](https://developer.android.com/reference/java/lang/Runnable.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/ThreadUtils.kt#L40) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-thread-utils/set-handler-for-test.md b/docs/api/mozilla.components.support.utils/-thread-utils/set-handler-for-test.md new file mode 100644 index 00000000000..226da3fc9fb --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-thread-utils/set-handler-for-test.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [ThreadUtils](index.md) / [setHandlerForTest](./set-handler-for-test.md) + +# setHandlerForTest + +`fun setHandlerForTest(handler: `[`Handler`](https://developer.android.com/reference/android/os/Handler.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/ThreadUtils.kt#L28) \ No newline at end of file diff --git a/docs/api/mozilla.components.support.utils/-web-u-r-l-finder/-init-.md b/docs/api/mozilla.components.support.utils/-web-u-r-l-finder/-init-.md new file mode 100644 index 00000000000..67b0b9094f3 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-web-u-r-l-finder/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [WebURLFinder](index.md) / [<init>](./-init-.md) + +# <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/mozilla.components.support.utils/-web-u-r-l-finder/best-web-u-r-l.md b/docs/api/mozilla.components.support.utils/-web-u-r-l-finder/best-web-u-r-l.md new file mode 100644 index 00000000000..08cb2314ea2 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-web-u-r-l-finder/best-web-u-r-l.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [WebURLFinder](index.md) / [bestWebURL](./best-web-u-r-l.md) + +# bestWebURL + +`fun bestWebURL(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/WebURLFinder.kt#L48) + +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/mozilla.components.support.utils/-web-u-r-l-finder/index.md b/docs/api/mozilla.components.support.utils/-web-u-r-l-finder/index.md new file mode 100644 index 00000000000..c2ffc030a44 --- /dev/null +++ b/docs/api/mozilla.components.support.utils/-web-u-r-l-finder/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [mozilla.components.support.utils](../index.md) / [WebURLFinder](./index.md) + +# WebURLFinder + +`class WebURLFinder` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/WebURLFinder.kt#L20) + +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 + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `WebURLFinder(string: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?)` | + +### Functions + +| Name | Summary | +|---|---| +| [bestWebURL](best-web-u-r-l.md) | `fun bestWebURL(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Return best Web URL. | diff --git a/docs/api/mozilla.components.support.utils/index.md b/docs/api/mozilla.components.support.utils/index.md new file mode 100644 index 00000000000..9f4132f7aee --- /dev/null +++ b/docs/api/mozilla.components.support.utils/index.md @@ -0,0 +1,23 @@ +[android-components](../index.md) / [mozilla.components.support.utils](./index.md) + +## Package mozilla.components.support.utils + +### Types + +| Name | Summary | +|---|---| +| [ColorUtils](-color-utils/index.md) | `object ColorUtils` | +| [DomainMatch](-domain-match/index.md) | `data class DomainMatch` | +| [DownloadUtils](-download-utils/index.md) | `object DownloadUtils` | +| [DrawableUtils](-drawable-utils/index.md) | `object DrawableUtils` | +| [SafeBundle](-safe-bundle/index.md) | `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.md) | `class SafeIntent`
External applications can pass values into Intents that can cause us to crash: in defense, we wrap [Intent](https://developer.android.com/reference/android/content/Intent.html) and catch the exceptions they may force us to throw. See bug 1090385 for more. | +| [StatusBarUtils](-status-bar-utils/index.md) | `object StatusBarUtils` | +| [ThreadUtils](-thread-utils/index.md) | `object ThreadUtils` | +| [WebURLFinder](-web-u-r-l-finder/index.md) | `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 | + +### Functions + +| Name | Summary | +|---|---| +| [segmentAwareDomainMatch](segment-aware-domain-match.md) | `fun segmentAwareDomainMatch(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, urls: `[`Iterable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterable/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>): `[`DomainMatch`](-domain-match/index.md)`?` | diff --git a/docs/api/mozilla.components.support.utils/segment-aware-domain-match.md b/docs/api/mozilla.components.support.utils/segment-aware-domain-match.md new file mode 100644 index 00000000000..1049a9b438e --- /dev/null +++ b/docs/api/mozilla.components.support.utils/segment-aware-domain-match.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.support.utils](index.md) / [segmentAwareDomainMatch](./segment-aware-domain-match.md) + +# segmentAwareDomainMatch + +`fun segmentAwareDomainMatch(query: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, urls: `[`Iterable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterable/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>): `[`DomainMatch`](-domain-match/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/support/utils/src/main/java/mozilla/components/support/utils/DomainMatcher.kt#L15) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/-init-.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/-init-.md new file mode 100644 index 00000000000..d38da6873fc --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/-init-.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](index.md) / [<init>](./-init-.md) + +# <init> + +`FetchTestCases()` + +Generic test cases for concept-fetch implementations. + +We expect any implementation of concept-fetch to pass all test cases here. + diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/create-new-client.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/create-new-client.md new file mode 100644 index 00000000000..8efe6292484 --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/create-new-client.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](index.md) / [createNewClient](./create-new-client.md) + +# createNewClient + +`abstract fun createNewClient(): `[`Client`](../../mozilla.components.concept.fetch/-client/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/fetch-tests/src/main/java/mozilla/components/tooling/fetch/tests/FetchTestCases.kt#L40) + +Creates a new [Client](../../mozilla.components.concept.fetch/-client/index.md) for running a specific test case with it. + diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/create-web-server.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/create-web-server.md new file mode 100644 index 00000000000..51bc5467a75 --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/create-web-server.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](index.md) / [createWebServer](./create-web-server.md) + +# createWebServer + +`open fun createWebServer(): MockWebServer` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/fetch-tests/src/main/java/mozilla/components/tooling/fetch/tests/FetchTestCases.kt#L45) + +Creates a new [MockWebServer](#) to accept test requests. + diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-overriding-default-headers.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-overriding-default-headers.md new file mode 100644 index 00000000000..1788a6b2361 --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-overriding-default-headers.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](index.md) / [get200OverridingDefaultHeaders](./get200-overriding-default-headers.md) + +# get200OverridingDefaultHeaders + +`open fun get200OverridingDefaultHeaders(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/fetch-tests/src/main/java/mozilla/components/tooling/fetch/tests/FetchTestCases.kt#L371) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-default-headers.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-default-headers.md new file mode 100644 index 00000000000..9e7ede2c2c2 --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-default-headers.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](index.md) / [get200WithDefaultHeaders](./get200-with-default-headers.md) + +# get200WithDefaultHeaders + +`open fun get200WithDefaultHeaders(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/fetch-tests/src/main/java/mozilla/components/tooling/fetch/tests/FetchTestCases.kt#L73) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-duplicated-cache-control-request-headers.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-duplicated-cache-control-request-headers.md new file mode 100644 index 00000000000..1f5a95e9319 --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-duplicated-cache-control-request-headers.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](index.md) / [get200WithDuplicatedCacheControlRequestHeaders](./get200-with-duplicated-cache-control-request-headers.md) + +# get200WithDuplicatedCacheControlRequestHeaders + +`open fun get200WithDuplicatedCacheControlRequestHeaders(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/fetch-tests/src/main/java/mozilla/components/tooling/fetch/tests/FetchTestCases.kt#L333) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-duplicated-cache-control-response-headers.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-duplicated-cache-control-response-headers.md new file mode 100644 index 00000000000..df40c253ae6 --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-duplicated-cache-control-response-headers.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](index.md) / [get200WithDuplicatedCacheControlResponseHeaders](./get200-with-duplicated-cache-control-response-headers.md) + +# get200WithDuplicatedCacheControlResponseHeaders + +`open fun get200WithDuplicatedCacheControlResponseHeaders(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/fetch-tests/src/main/java/mozilla/components/tooling/fetch/tests/FetchTestCases.kt#L305) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-gzipped-body.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-gzipped-body.md new file mode 100644 index 00000000000..4373baa94b7 --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-gzipped-body.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](index.md) / [get200WithGzippedBody](./get200-with-gzipped-body.md) + +# get200WithGzippedBody + +`open fun get200WithGzippedBody(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/fetch-tests/src/main/java/mozilla/components/tooling/fetch/tests/FetchTestCases.kt#L193) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-headers.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-headers.md new file mode 100644 index 00000000000..0062743e9c1 --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-headers.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](index.md) / [get200WithHeaders](./get200-with-headers.md) + +# get200WithHeaders + +`open fun get200WithHeaders(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/fetch-tests/src/main/java/mozilla/components/tooling/fetch/tests/FetchTestCases.kt#L112) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-read-timeout.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-read-timeout.md new file mode 100644 index 00000000000..2c2b9561d21 --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-read-timeout.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](index.md) / [get200WithReadTimeout](./get200-with-read-timeout.md) + +# get200WithReadTimeout + +`open fun get200WithReadTimeout(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/fetch-tests/src/main/java/mozilla/components/tooling/fetch/tests/FetchTestCases.kt#L239) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-string-body.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-string-body.md new file mode 100644 index 00000000000..6a597596144 --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-string-body.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](index.md) / [get200WithStringBody](./get200-with-string-body.md) + +# get200WithStringBody + +`open fun get200WithStringBody(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/fetch-tests/src/main/java/mozilla/components/tooling/fetch/tests/FetchTestCases.kt#L48) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-user-agent.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-user-agent.md new file mode 100644 index 00000000000..0e417530992 --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get200-with-user-agent.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](index.md) / [get200WithUserAgent](./get200-with-user-agent.md) + +# get200WithUserAgent + +`open fun get200WithUserAgent(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/fetch-tests/src/main/java/mozilla/components/tooling/fetch/tests/FetchTestCases.kt#L175) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get302-follow-redirects-disabled.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get302-follow-redirects-disabled.md new file mode 100644 index 00000000000..be9b3484ede --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get302-follow-redirects-disabled.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](index.md) / [get302FollowRedirectsDisabled](./get302-follow-redirects-disabled.md) + +# get302FollowRedirectsDisabled + +`open fun get302FollowRedirectsDisabled(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/fetch-tests/src/main/java/mozilla/components/tooling/fetch/tests/FetchTestCases.kt#L224) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get302-follow-redirects.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get302-follow-redirects.md new file mode 100644 index 00000000000..2fe17e92c1d --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get302-follow-redirects.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](index.md) / [get302FollowRedirects](./get302-follow-redirects.md) + +# get302FollowRedirects + +`open fun get302FollowRedirects(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/fetch-tests/src/main/java/mozilla/components/tooling/fetch/tests/FetchTestCases.kt#L207) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get404-with-body.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get404-with-body.md new file mode 100644 index 00000000000..f877cabf73b --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/get404-with-body.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](index.md) / [get404WithBody](./get404-with-body.md) + +# get404WithBody + +`open fun get404WithBody(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/fetch-tests/src/main/java/mozilla/components/tooling/fetch/tests/FetchTestCases.kt#L59) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/index.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/index.md new file mode 100644 index 00000000000..9ad9879f2af --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/index.md @@ -0,0 +1,36 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](./index.md) + +# FetchTestCases + +`abstract class FetchTestCases` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/fetch-tests/src/main/java/mozilla/components/tooling/fetch/tests/FetchTestCases.kt#L36) + +Generic test cases for concept-fetch implementations. + +We expect any implementation of concept-fetch to pass all test cases here. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FetchTestCases()`
Generic test cases for concept-fetch implementations. | + +### Functions + +| Name | Summary | +|---|---| +| [createNewClient](create-new-client.md) | `abstract fun createNewClient(): `[`Client`](../../mozilla.components.concept.fetch/-client/index.md)
Creates a new [Client](../../mozilla.components.concept.fetch/-client/index.md) for running a specific test case with it. | +| [createWebServer](create-web-server.md) | `open fun createWebServer(): MockWebServer`
Creates a new [MockWebServer](#) to accept test requests. | +| [get200OverridingDefaultHeaders](get200-overriding-default-headers.md) | `open fun get200OverridingDefaultHeaders(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [get200WithDefaultHeaders](get200-with-default-headers.md) | `open fun get200WithDefaultHeaders(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [get200WithDuplicatedCacheControlRequestHeaders](get200-with-duplicated-cache-control-request-headers.md) | `open fun get200WithDuplicatedCacheControlRequestHeaders(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [get200WithDuplicatedCacheControlResponseHeaders](get200-with-duplicated-cache-control-response-headers.md) | `open fun get200WithDuplicatedCacheControlResponseHeaders(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [get200WithGzippedBody](get200-with-gzipped-body.md) | `open fun get200WithGzippedBody(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [get200WithHeaders](get200-with-headers.md) | `open fun get200WithHeaders(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [get200WithReadTimeout](get200-with-read-timeout.md) | `open fun get200WithReadTimeout(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [get200WithStringBody](get200-with-string-body.md) | `open fun get200WithStringBody(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [get200WithUserAgent](get200-with-user-agent.md) | `open fun get200WithUserAgent(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [get302FollowRedirects](get302-follow-redirects.md) | `open fun get302FollowRedirects(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [get302FollowRedirectsDisabled](get302-follow-redirects-disabled.md) | `open fun get302FollowRedirectsDisabled(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [get404WithBody](get404-with-body.md) | `open fun get404WithBody(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [post200WithBody](post200-with-body.md) | `open fun post200WithBody(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [put201FileUpload](put201-file-upload.md) | `open fun put201FileUpload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/post200-with-body.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/post200-with-body.md new file mode 100644 index 00000000000..c3fb7c3dc27 --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/post200-with-body.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](index.md) / [post200WithBody](./post200-with-body.md) + +# post200WithBody + +`open fun post200WithBody(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/fetch-tests/src/main/java/mozilla/components/tooling/fetch/tests/FetchTestCases.kt#L156) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/put201-file-upload.md b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/put201-file-upload.md new file mode 100644 index 00000000000..319ecdf9549 --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/-fetch-test-cases/put201-file-upload.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.fetch.tests](../index.md) / [FetchTestCases](index.md) / [put201FileUpload](./put201-file-upload.md) + +# put201FileUpload + +`open fun put201FileUpload(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/fetch-tests/src/main/java/mozilla/components/tooling/fetch/tests/FetchTestCases.kt#L262) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.fetch.tests/index.md b/docs/api/mozilla.components.tooling.fetch.tests/index.md new file mode 100644 index 00000000000..4ab147ff4c0 --- /dev/null +++ b/docs/api/mozilla.components.tooling.fetch.tests/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.tooling.fetch.tests](./index.md) + +## Package mozilla.components.tooling.fetch.tests + +### Types + +| Name | Summary | +|---|---| +| [FetchTestCases](-fetch-test-cases/index.md) | `abstract class FetchTestCases`
Generic test cases for concept-fetch implementations. | diff --git a/docs/api/mozilla.components.tooling.lint/-lint-issue-registry/-init-.md b/docs/api/mozilla.components.tooling.lint/-lint-issue-registry/-init-.md new file mode 100644 index 00000000000..4a1c4259101 --- /dev/null +++ b/docs/api/mozilla.components.tooling.lint/-lint-issue-registry/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.tooling.lint](../index.md) / [LintIssueRegistry](index.md) / [<init>](./-init-.md) + +# <init> + +`LintIssueRegistry()` + +Registry which provides a list of our custom lint checks to be performed on an Android project. + diff --git a/docs/api/mozilla.components.tooling.lint/-lint-issue-registry/api.md b/docs/api/mozilla.components.tooling.lint/-lint-issue-registry/api.md new file mode 100644 index 00000000000..ab75aa73e9c --- /dev/null +++ b/docs/api/mozilla.components.tooling.lint/-lint-issue-registry/api.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.lint](../index.md) / [LintIssueRegistry](index.md) / [api](./api.md) + +# api + +`val api: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/lint/src/main/java/mozilla/components/tooling/lint/LintIssueRegistry.kt#L15) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.lint/-lint-issue-registry/index.md b/docs/api/mozilla.components.tooling.lint/-lint-issue-registry/index.md new file mode 100644 index 00000000000..67f78ff5af0 --- /dev/null +++ b/docs/api/mozilla.components.tooling.lint/-lint-issue-registry/index.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [mozilla.components.tooling.lint](../index.md) / [LintIssueRegistry](./index.md) + +# LintIssueRegistry + +`class LintIssueRegistry` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/lint/src/main/java/mozilla/components/tooling/lint/LintIssueRegistry.kt#L14) + +Registry which provides a list of our custom lint checks to be performed on an Android project. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `LintIssueRegistry()`
Registry which provides a list of our custom lint checks to be performed on an Android project. | + +### Properties + +| Name | Summary | +|---|---| +| [api](api.md) | `val api: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [issues](issues.md) | `val issues: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<>` | diff --git a/docs/api/mozilla.components.tooling.lint/-lint-issue-registry/issues.md b/docs/api/mozilla.components.tooling.lint/-lint-issue-registry/issues.md new file mode 100644 index 00000000000..1616d7a6956 --- /dev/null +++ b/docs/api/mozilla.components.tooling.lint/-lint-issue-registry/issues.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.lint](../index.md) / [LintIssueRegistry](index.md) / [issues](./issues.md) + +# issues + +`val issues: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/lint/src/main/java/mozilla/components/tooling/lint/LintIssueRegistry.kt#L16) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.lint/-lint-log-checks/-init-.md b/docs/api/mozilla.components.tooling.lint/-lint-log-checks/-init-.md new file mode 100644 index 00000000000..5ef7b76a163 --- /dev/null +++ b/docs/api/mozilla.components.tooling.lint/-lint-log-checks/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.tooling.lint](../index.md) / [LintLogChecks](index.md) / [<init>](./-init-.md) + +# <init> + +`LintLogChecks()` + +Custom lint checks related to logging. + diff --git a/docs/api/mozilla.components.tooling.lint/-lint-log-checks/get-applicable-method-names.md b/docs/api/mozilla.components.tooling.lint/-lint-log-checks/get-applicable-method-names.md new file mode 100644 index 00000000000..cae791fd594 --- /dev/null +++ b/docs/api/mozilla.components.tooling.lint/-lint-log-checks/get-applicable-method-names.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.lint](../index.md) / [LintLogChecks](index.md) / [getApplicableMethodNames](./get-applicable-method-names.md) + +# getApplicableMethodNames + +`fun getApplicableMethodNames(): `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/lint/src/main/java/mozilla/components/tooling/lint/LintLogChecks.kt#L28) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.lint/-lint-log-checks/index.md b/docs/api/mozilla.components.tooling.lint/-lint-log-checks/index.md new file mode 100644 index 00000000000..383d8b119c7 --- /dev/null +++ b/docs/api/mozilla.components.tooling.lint/-lint-log-checks/index.md @@ -0,0 +1,26 @@ +[android-components](../../index.md) / [mozilla.components.tooling.lint](../index.md) / [LintLogChecks](./index.md) + +# LintLogChecks + +`class LintLogChecks` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/lint/src/main/java/mozilla/components/tooling/lint/LintLogChecks.kt#L25) + +Custom lint checks related to logging. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `LintLogChecks()`
Custom lint checks related to logging. | + +### Functions + +| Name | Summary | +|---|---| +| [getApplicableMethodNames](get-applicable-method-names.md) | `fun getApplicableMethodNames(): `[`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)`>` | +| [visitMethod](visit-method.md) | `fun visitMethod(context: , node: , method: ): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Companion Object Properties + +| Name | Summary | +|---|---| +| [issues](issues.md) | `val issues: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<>` | diff --git a/docs/api/mozilla.components.tooling.lint/-lint-log-checks/issues.md b/docs/api/mozilla.components.tooling.lint/-lint-log-checks/issues.md new file mode 100644 index 00000000000..0bdeec41d8c --- /dev/null +++ b/docs/api/mozilla.components.tooling.lint/-lint-log-checks/issues.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.lint](../index.md) / [LintLogChecks](index.md) / [issues](./issues.md) + +# issues + +`val issues: `[`List`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/lint/src/main/java/mozilla/components/tooling/lint/LintLogChecks.kt#L59) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.lint/-lint-log-checks/visit-method.md b/docs/api/mozilla.components.tooling.lint/-lint-log-checks/visit-method.md new file mode 100644 index 00000000000..354a2135b85 --- /dev/null +++ b/docs/api/mozilla.components.tooling.lint/-lint-log-checks/visit-method.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.tooling.lint](../index.md) / [LintLogChecks](index.md) / [visitMethod](./visit-method.md) + +# visitMethod + +`fun visitMethod(context: , node: , method: ): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/tooling/lint/src/main/java/mozilla/components/tooling/lint/LintLogChecks.kt#L30) \ No newline at end of file diff --git a/docs/api/mozilla.components.tooling.lint/index.md b/docs/api/mozilla.components.tooling.lint/index.md new file mode 100644 index 00000000000..c6cad97e381 --- /dev/null +++ b/docs/api/mozilla.components.tooling.lint/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [mozilla.components.tooling.lint](./index.md) + +## Package mozilla.components.tooling.lint + +### Types + +| Name | Summary | +|---|---| +| [LintIssueRegistry](-lint-issue-registry/index.md) | `class LintIssueRegistry`
Registry which provides a list of our custom lint checks to be performed on an Android project. | +| [LintLogChecks](-lint-log-checks/index.md) | `class LintLogChecks`
Custom lint checks related to logging. | diff --git a/docs/api/mozilla.components.ui.autocomplete/-autocomplete-view/apply-autocomplete-result.md b/docs/api/mozilla.components.ui.autocomplete/-autocomplete-view/apply-autocomplete-result.md new file mode 100644 index 00000000000..266815945a3 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-autocomplete-view/apply-autocomplete-result.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [AutocompleteView](index.md) / [applyAutocompleteResult](./apply-autocomplete-result.md) + +# applyAutocompleteResult + +`abstract fun applyAutocompleteResult(result: `[`AutocompleteResult`](../-inline-autocomplete-edit-text/-autocomplete-result/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L56) + +Apply provided [result](apply-autocomplete-result.md#mozilla.components.ui.autocomplete.AutocompleteView$applyAutocompleteResult(mozilla.components.ui.autocomplete.InlineAutocompleteEditText.AutocompleteResult)/result) autocomplete result. + diff --git a/docs/api/mozilla.components.ui.autocomplete/-autocomplete-view/index.md b/docs/api/mozilla.components.ui.autocomplete/-autocomplete-view/index.md new file mode 100644 index 00000000000..d1cb139141a --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-autocomplete-view/index.md @@ -0,0 +1,26 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [AutocompleteView](./index.md) + +# AutocompleteView + +`interface AutocompleteView` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L47) + +Aids in testing functionality which relies on some aspects of InlineAutocompleteEditText. + +### Properties + +| Name | Summary | +|---|---| +| [originalText](original-text.md) | `abstract val originalText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Current text. | + +### Functions + +| Name | Summary | +|---|---| +| [applyAutocompleteResult](apply-autocomplete-result.md) | `abstract fun applyAutocompleteResult(result: `[`AutocompleteResult`](../-inline-autocomplete-edit-text/-autocomplete-result/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Apply provided [result](apply-autocomplete-result.md#mozilla.components.ui.autocomplete.AutocompleteView$applyAutocompleteResult(mozilla.components.ui.autocomplete.InlineAutocompleteEditText.AutocompleteResult)/result) autocomplete result. | +| [noAutocompleteResult](no-autocomplete-result.md) | `abstract fun noAutocompleteResult(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Notify that there is no autocomplete result available. | + +### Inheritors + +| Name | Summary | +|---|---| +| [InlineAutocompleteEditText](../-inline-autocomplete-edit-text/index.md) | `open class InlineAutocompleteEditText : AppCompatEditText, `[`AutocompleteView`](./index.md)
A UI edit text component which supports inline autocompletion. | diff --git a/docs/api/mozilla.components.ui.autocomplete/-autocomplete-view/no-autocomplete-result.md b/docs/api/mozilla.components.ui.autocomplete/-autocomplete-view/no-autocomplete-result.md new file mode 100644 index 00000000000..56b3af76a4c --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-autocomplete-view/no-autocomplete-result.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [AutocompleteView](index.md) / [noAutocompleteResult](./no-autocomplete-result.md) + +# noAutocompleteResult + +`abstract fun noAutocompleteResult(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L61) + +Notify that there is no autocomplete result available. + diff --git a/docs/api/mozilla.components.ui.autocomplete/-autocomplete-view/original-text.md b/docs/api/mozilla.components.ui.autocomplete/-autocomplete-view/original-text.md new file mode 100644 index 00000000000..98b626f2404 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-autocomplete-view/original-text.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [AutocompleteView](index.md) / [originalText](./original-text.md) + +# originalText + +`abstract val originalText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L51) + +Current text. + diff --git a/docs/api/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/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..603e85f1fae --- /dev/null +++ b/docs/api/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,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [AUTOCOMPLETE_SPAN](./-a-u-t-o-c-o-m-p-l-e-t-e_-s-p-a-n.md) + +# AUTOCOMPLETE_SPAN + +`val AUTOCOMPLETE_SPAN: `[`Concrete`](https://developer.android.com/reference/android/text/NoCopySpan/Concrete.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L661) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/-init-.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/-init-.md new file mode 100644 index 00000000000..11c21bedec6 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.ui.autocomplete](../../index.md) / [InlineAutocompleteEditText](../index.md) / [AutocompleteResult](index.md) / [<init>](./-init-.md) + +# <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.md)`? = null)` \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/index.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/index.md new file mode 100644 index 00000000000..42c5eb6771a --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/index.md @@ -0,0 +1,25 @@ +[android-components](../../../index.md) / [mozilla.components.ui.autocomplete](../../index.md) / [InlineAutocompleteEditText](../index.md) / [AutocompleteResult](./index.md) + +# AutocompleteResult + +`data class AutocompleteResult` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L92) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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.md)`? = null)` | + +### Properties + +| Name | Summary | +|---|---| +| [source](source.md) | `val source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [text](text.md) | `val text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [totalItems](total-items.md) | `val totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [startsWith](starts-with.md) | `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) | diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/source.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/source.md new file mode 100644 index 00000000000..110f8ed27e9 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/source.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.ui.autocomplete](../../index.md) / [InlineAutocompleteEditText](../index.md) / [AutocompleteResult](index.md) / [source](./source.md) + +# source + +`val source: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L94) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/starts-with.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/starts-with.md new file mode 100644 index 00000000000..5ddab6d05ef --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/starts-with.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.ui.autocomplete](../../index.md) / [InlineAutocompleteEditText](../index.md) / [AutocompleteResult](index.md) / [startsWith](./starts-with.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L98) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/text.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/text.md new file mode 100644 index 00000000000..877f3407002 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/text.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.ui.autocomplete](../../index.md) / [InlineAutocompleteEditText](../index.md) / [AutocompleteResult](index.md) / [text](./text.md) + +# text + +`val text: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L93) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/total-items.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/total-items.md new file mode 100644 index 00000000000..a7a00eca8fd --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-autocomplete-result/total-items.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [mozilla.components.ui.autocomplete](../../index.md) / [InlineAutocompleteEditText](../index.md) / [AutocompleteResult](index.md) / [totalItems](./total-items.md) + +# totalItems + +`val totalItems: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L95) \ No newline at end of file diff --git a/docs/api/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/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..a3208a64fb9 --- /dev/null +++ b/docs/api/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,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [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.md) + +# DEFAULT_AUTOCOMPLETE_BACKGROUND_COLOR + +`val DEFAULT_AUTOCOMPLETE_BACKGROUND_COLOR: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L662) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-i-n-p-u-t_-m-e-t-h-o-d_-a-m-a-z-o-n_-e-c-h-o_-s-h-o-w.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-i-n-p-u-t_-m-e-t-h-o-d_-a-m-a-z-o-n_-e-c-h-o_-s-h-o-w.md new file mode 100644 index 00000000000..95da96ebc12 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-i-n-p-u-t_-m-e-t-h-o-d_-a-m-a-z-o-n_-e-c-h-o_-s-h-o-w.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [INPUT_METHOD_AMAZON_ECHO_SHOW](./-i-n-p-u-t_-m-e-t-h-o-d_-a-m-a-z-o-n_-e-c-h-o_-s-h-o-w.md) + +# INPUT_METHOD_AMAZON_ECHO_SHOW + +`const val INPUT_METHOD_AMAZON_ECHO_SHOW: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L667) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-i-n-p-u-t_-m-e-t-h-o-d_-s-o-n-y.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-i-n-p-u-t_-m-e-t-h-o-d_-s-o-n-y.md new file mode 100644 index 00000000000..542c5b5a0f3 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-i-n-p-u-t_-m-e-t-h-o-d_-s-o-n-y.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [INPUT_METHOD_SONY](./-i-n-p-u-t_-m-e-t-h-o-d_-s-o-n-y.md) + +# INPUT_METHOD_SONY + +`const val INPUT_METHOD_SONY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L668) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-init-.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-init-.md new file mode 100644 index 00000000000..ba668e86963 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/-init-.md @@ -0,0 +1,26 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [<init>](./-init-.md) + +# <init> + +`InlineAutocompleteEditText(ctx: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = 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.md)) 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.md)) 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.md) and [setOnWindowsFocusChangeListener](set-on-windows-focus-change-listener.md) which +will be invoked in response to [onSelectionChanged](on-selection-changed.md) and [onWindowFocusChanged](on-window-focus-changed.md) +respectively (see also [setOnTextChangeListener](set-on-text-change-listener.md), +[setOnSelectionChangedListener](set-on-selection-changed-listener.md), and [setOnWindowsFocusChangeListener](set-on-windows-focus-change-listener.md)). + diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/apply-autocomplete-result.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/apply-autocomplete-result.md new file mode 100644 index 00000000000..728a71cb451 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/apply-autocomplete-result.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [applyAutocompleteResult](./apply-autocomplete-result.md) + +# applyAutocompleteResult + +`open fun applyAutocompleteResult(result: `[`AutocompleteResult`](-autocomplete-result/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L375) + +Overrides [AutocompleteView.applyAutocompleteResult](../-autocomplete-view/apply-autocomplete-result.md) + +Applies the provided result by updating the current autocomplete +text and selection, if any. + +### Parameters + +`result` - the [AutocompleteProvider.AutocompleteResult](#) to apply \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/autocomplete-result.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/autocomplete-result.md new file mode 100644 index 00000000000..b59d2a0f06c --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/autocomplete-result.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [autocompleteResult](./autocomplete-result.md) + +# autocompleteResult + +`var autocompleteResult: `[`AutocompleteResult`](-autocomplete-result/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L123) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/get-text.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/get-text.md new file mode 100644 index 00000000000..084926ffea9 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/get-text.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [getText](./get-text.md) + +# getText + +`open fun getText(): `[`Editable`](https://developer.android.com/reference/android/text/Editable.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L260) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/index.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/index.md new file mode 100644 index 00000000000..970ffc45864 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/index.md @@ -0,0 +1,96 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](./index.md) + +# InlineAutocompleteEditText + +`open class InlineAutocompleteEditText : AppCompatEditText, `[`AutocompleteView`](../-autocomplete-view/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L86) + +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.md)) 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.md)) 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.md) and [setOnWindowsFocusChangeListener](set-on-windows-focus-change-listener.md) which +will be invoked in response to [onSelectionChanged](on-selection-changed.md) and [onWindowFocusChanged](on-window-focus-changed.md) +respectively (see also [setOnTextChangeListener](set-on-text-change-listener.md), +[setOnSelectionChangedListener](set-on-selection-changed-listener.md), and [setOnWindowsFocusChangeListener](set-on-windows-focus-change-listener.md)). + +### Types + +| Name | Summary | +|---|---| +| [AutocompleteResult](-autocomplete-result/index.md) | `data class AutocompleteResult` | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `InlineAutocompleteEditText(ctx: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = 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 + +| Name | Summary | +|---|---| +| [autocompleteResult](autocomplete-result.md) | `var autocompleteResult: `[`AutocompleteResult`](-autocomplete-result/index.md)`?` | +| [nonAutocompleteText](non-autocomplete-text.md) | `val nonAutocompleteText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [originalText](original-text.md) | `open val originalText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Current text. | + +### Functions + +| Name | Summary | +|---|---| +| [applyAutocompleteResult](apply-autocomplete-result.md) | `open fun applyAutocompleteResult(result: `[`AutocompleteResult`](-autocomplete-result/index.md)`): `[`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. | +| [getText](get-text.md) | `open fun getText(): `[`Editable`](https://developer.android.com/reference/android/text/Editable.html) | +| [noAutocompleteResult](no-autocomplete-result.md) | `open fun noAutocompleteResult(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Notify that there is no autocomplete result available. | +| [onAttachedToWindow](on-attached-to-window.md) | `open fun onAttachedToWindow(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onCreateInputConnection](on-create-input-connection.md) | `open fun onCreateInputConnection(outAttrs: `[`EditorInfo`](https://developer.android.com/reference/android/view/inputmethod/EditorInfo.html)`): `[`InputConnection`](https://developer.android.com/reference/android/view/inputmethod/InputConnection.html)`?`
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.md) | `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`](https://developer.android.com/reference/android/graphics/Rect.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [onKeyPreIme](on-key-pre-ime.md) | `open fun onKeyPreIme(keyCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, event: `[`KeyEvent`](https://developer.android.com/reference/android/view/KeyEvent.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onSelectionChanged](on-selection-changed.md) | `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.md) | `open fun onTouchEvent(event: `[`MotionEvent`](https://developer.android.com/reference/android/view/MotionEvent.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onWindowFocusChanged](on-window-focus-changed.md) | `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.md) | `open fun sendAccessibilityEventUnchecked(event: `[`AccessibilityEvent`](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setOnCommitListener](set-on-commit-listener.md) | `fun setOnCommitListener(l: `[`OnCommitListener`](../-on-commit-listener.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setOnFilterListener](set-on-filter-listener.md) | `fun setOnFilterListener(l: `[`OnFilterListener`](../-on-filter-listener.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setOnKeyPreImeListener](set-on-key-pre-ime-listener.md) | `fun setOnKeyPreImeListener(l: `[`OnKeyPreImeListener`](../-on-key-pre-ime-listener.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setOnSearchStateChangeListener](set-on-search-state-change-listener.md) | `fun setOnSearchStateChangeListener(l: `[`OnSearchStateChangeListener`](../-on-search-state-change-listener.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setOnSelectionChangedListener](set-on-selection-changed-listener.md) | `fun setOnSelectionChangedListener(l: `[`OnSelectionChangedListener`](../-on-selection-changed-listener.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setOnTextChangeListener](set-on-text-change-listener.md) | `fun setOnTextChangeListener(l: `[`OnTextChangeListener`](../-on-text-change-listener.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setOnWindowsFocusChangeListener](set-on-windows-focus-change-listener.md) | `fun setOnWindowsFocusChangeListener(l: `[`OnWindowsFocusChangeListener`](../-on-windows-focus-change-listener.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setText](set-text.md) | `open fun setText(text: `[`CharSequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)`?, type: `[`BufferType`](https://developer.android.com/reference/android/widget/TextView/BufferType.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Companion Object Properties + +| Name | Summary | +|---|---| +| [AUTOCOMPLETE_SPAN](-a-u-t-o-c-o-m-p-l-e-t-e_-s-p-a-n.md) | `val AUTOCOMPLETE_SPAN: `[`Concrete`](https://developer.android.com/reference/android/text/NoCopySpan/Concrete.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.md) | `val DEFAULT_AUTOCOMPLETE_BACKGROUND_COLOR: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [INPUT_METHOD_AMAZON_ECHO_SHOW](-i-n-p-u-t_-m-e-t-h-o-d_-a-m-a-z-o-n_-e-c-h-o_-s-h-o-w.md) | `const val INPUT_METHOD_AMAZON_ECHO_SHOW: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [INPUT_METHOD_SONY](-i-n-p-u-t_-m-e-t-h-o-d_-s-o-n-y.md) | `const val INPUT_METHOD_SONY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Extension Properties + +| Name | Summary | +|---|---| +| [isLTR](../../mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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? | + +### Extension Functions + +| Name | Summary | +|---|---| +| [hideKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.hideKeyboard(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Hides the soft input window. | +| [isGone](../../mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [isVisible](../../mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [setPadding](../../mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.setPadding(padding: `[`Padding`](../../mozilla.components.support.base.android/-padding/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Set a padding using [Padding](../../mozilla.components.support.base.android/-padding/index.md) object. | +| [showKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/no-autocomplete-result.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/no-autocomplete-result.md new file mode 100644 index 00000000000..b62b9047e27 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/no-autocomplete-result.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [noAutocompleteResult](./no-autocomplete-result.md) + +# noAutocompleteResult + +`open fun noAutocompleteResult(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L481) + +Overrides [AutocompleteView.noAutocompleteResult](../-autocomplete-view/no-autocomplete-result.md) + +Notify that there is no autocomplete result available. + diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/non-autocomplete-text.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/non-autocomplete-text.md new file mode 100644 index 00000000000..4cccd25863c --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/non-autocomplete-text.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [nonAutocompleteText](./non-autocomplete-text.md) + +# nonAutocompleteText + +`val nonAutocompleteText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L135) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-attached-to-window.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-attached-to-window.md new file mode 100644 index 00000000000..b8eb1fa57e9 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-attached-to-window.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [onAttachedToWindow](./on-attached-to-window.md) + +# onAttachedToWindow + +`open fun onAttachedToWindow(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L218) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-create-input-connection.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-create-input-connection.md new file mode 100644 index 00000000000..54a72054af3 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-create-input-connection.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [onCreateInputConnection](./on-create-input-connection.md) + +# onCreateInputConnection + +`open fun onCreateInputConnection(outAttrs: `[`EditorInfo`](https://developer.android.com/reference/android/view/inputmethod/EditorInfo.html)`): `[`InputConnection`](https://developer.android.com/reference/android/view/inputmethod/InputConnection.html)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L493) + +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/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-focus-changed.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-focus-changed.md new file mode 100644 index 00000000000..d865231b582 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-focus-changed.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [onFocusChanged](./on-focus-changed.md) + +# 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`](https://developer.android.com/reference/android/graphics/Rect.html)`?): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L228) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-key-pre-ime.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-key-pre-ime.md new file mode 100644 index 00000000000..2d8a3b53b31 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-key-pre-ime.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [onKeyPreIme](./on-key-pre-ime.md) + +# onKeyPreIme + +`open fun onKeyPreIme(keyCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, event: `[`KeyEvent`](https://developer.android.com/reference/android/view/KeyEvent.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L619) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-selection-changed.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-selection-changed.md new file mode 100644 index 00000000000..da86b3bd361 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-selection-changed.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [onSelectionChanged](./on-selection-changed.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L623) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-touch-event.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-touch-event.md new file mode 100644 index 00000000000..5f26c84cd2b --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-touch-event.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [onTouchEvent](./on-touch-event.md) + +# onTouchEvent + +`open fun onTouchEvent(event: `[`MotionEvent`](https://developer.android.com/reference/android/view/MotionEvent.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L634) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-window-focus-changed.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-window-focus-changed.md new file mode 100644 index 00000000000..33dd6ae2108 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/on-window-focus-changed.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [onWindowFocusChanged](./on-window-focus-changed.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L628) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/original-text.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/original-text.md new file mode 100644 index 00000000000..fd95ec536af --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/original-text.md @@ -0,0 +1,10 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [originalText](./original-text.md) + +# originalText + +`open val originalText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L138) + +Overrides [AutocompleteView.originalText](../-autocomplete-view/original-text.md) + +Current text. + diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/send-accessibility-event-unchecked.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/send-accessibility-event-unchecked.md new file mode 100644 index 00000000000..ad70ec93f8f --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/send-accessibility-event-unchecked.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [sendAccessibilityEventUnchecked](./send-accessibility-event-unchecked.md) + +# sendAccessibilityEventUnchecked + +`open fun sendAccessibilityEventUnchecked(event: `[`AccessibilityEvent`](https://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L264) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-commit-listener.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-commit-listener.md new file mode 100644 index 00000000000..4578f1e4380 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-commit-listener.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [setOnCommitListener](./set-on-commit-listener.md) + +# setOnCommitListener + +`fun setOnCommitListener(l: `[`OnCommitListener`](../-on-commit-listener.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L102) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-filter-listener.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-filter-listener.md new file mode 100644 index 00000000000..ee1f0f2814c --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-filter-listener.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [setOnFilterListener](./set-on-filter-listener.md) + +# setOnFilterListener + +`fun setOnFilterListener(l: `[`OnFilterListener`](../-on-filter-listener.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L105) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-key-pre-ime-listener.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-key-pre-ime-listener.md new file mode 100644 index 00000000000..d0e325a3f82 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-key-pre-ime-listener.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [setOnKeyPreImeListener](./set-on-key-pre-ime-listener.md) + +# setOnKeyPreImeListener + +`fun setOnKeyPreImeListener(l: `[`OnKeyPreImeListener`](../-on-key-pre-ime-listener.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L114) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-search-state-change-listener.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-search-state-change-listener.md new file mode 100644 index 00000000000..fabdbbdaaaa --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-search-state-change-listener.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [setOnSearchStateChangeListener](./set-on-search-state-change-listener.md) + +# setOnSearchStateChangeListener + +`fun setOnSearchStateChangeListener(l: `[`OnSearchStateChangeListener`](../-on-search-state-change-listener.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L108) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-selection-changed-listener.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-selection-changed-listener.md new file mode 100644 index 00000000000..f5f1d72ca04 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-selection-changed-listener.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [setOnSelectionChangedListener](./set-on-selection-changed-listener.md) + +# setOnSelectionChangedListener + +`fun setOnSelectionChangedListener(l: `[`OnSelectionChangedListener`](../-on-selection-changed-listener.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L117) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-text-change-listener.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-text-change-listener.md new file mode 100644 index 00000000000..96314fda74c --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-text-change-listener.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [setOnTextChangeListener](./set-on-text-change-listener.md) + +# setOnTextChangeListener + +`fun setOnTextChangeListener(l: `[`OnTextChangeListener`](../-on-text-change-listener.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L111) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-windows-focus-change-listener.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-windows-focus-change-listener.md new file mode 100644 index 00000000000..91fdf5e0e1b --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-on-windows-focus-change-listener.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [setOnWindowsFocusChangeListener](./set-on-windows-focus-change-listener.md) + +# setOnWindowsFocusChangeListener + +`fun setOnWindowsFocusChangeListener(l: `[`OnWindowsFocusChangeListener`](../-on-windows-focus-change-listener.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L120) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-text.md b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-text.md new file mode 100644 index 00000000000..3ac5f636478 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-inline-autocomplete-edit-text/set-text.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.autocomplete](../index.md) / [InlineAutocompleteEditText](index.md) / [setText](./set-text.md) + +# setText + +`open fun setText(text: `[`CharSequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)`?, type: `[`BufferType`](https://developer.android.com/reference/android/widget/TextView/BufferType.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L252) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-on-commit-listener.md b/docs/api/mozilla.components.ui.autocomplete/-on-commit-listener.md new file mode 100644 index 00000000000..bf108a1cd1f --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-on-commit-listener.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.ui.autocomplete](index.md) / [OnCommitListener](./-on-commit-listener.md) + +# OnCommitListener + +`typealias OnCommitListener = () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L34) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-on-filter-listener.md b/docs/api/mozilla.components.ui.autocomplete/-on-filter-listener.md new file mode 100644 index 00000000000..a782f182d13 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-on-filter-listener.md @@ -0,0 +1,11 @@ +[android-components](../index.md) / [mozilla.components.ui.autocomplete](index.md) / [OnFilterListener](./-on-filter-listener.md) + +# OnFilterListener + +`typealias OnFilterListener = (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L35) + +### Inheritors + +| Name | Summary | +|---|---| +| [AsyncFilterListener](../mozilla.components.browser.toolbar/-async-filter-listener/index.md) | `class AsyncFilterListener : `[`OnFilterListener`](./-on-filter-listener.md)`, CoroutineScope`
Wraps [filter](#) execution in a coroutine context, cancelling prior executions on every invocation. [coroutineContext](../mozilla.components.browser.toolbar/-async-filter-listener/coroutine-context.md) must be of type that doesn't propagate cancellation of its children upwards. | diff --git a/docs/api/mozilla.components.ui.autocomplete/-on-key-pre-ime-listener.md b/docs/api/mozilla.components.ui.autocomplete/-on-key-pre-ime-listener.md new file mode 100644 index 00000000000..975baab2b64 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-on-key-pre-ime-listener.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.ui.autocomplete](index.md) / [OnKeyPreImeListener](./-on-key-pre-ime-listener.md) + +# OnKeyPreImeListener + +`typealias OnKeyPreImeListener = (`[`View`](https://developer.android.com/reference/android/view/View.html)`, `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `[`KeyEvent`](https://developer.android.com/reference/android/view/KeyEvent.html)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L38) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-on-search-state-change-listener.md b/docs/api/mozilla.components.ui.autocomplete/-on-search-state-change-listener.md new file mode 100644 index 00000000000..2c8944cadf9 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-on-search-state-change-listener.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.ui.autocomplete](index.md) / [OnSearchStateChangeListener](./-on-search-state-change-listener.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L36) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-on-selection-changed-listener.md b/docs/api/mozilla.components.ui.autocomplete/-on-selection-changed-listener.md new file mode 100644 index 00000000000..ce54e100a65 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-on-selection-changed-listener.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.ui.autocomplete](index.md) / [OnSelectionChangedListener](./-on-selection-changed-listener.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L39) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-on-text-change-listener.md b/docs/api/mozilla.components.ui.autocomplete/-on-text-change-listener.md new file mode 100644 index 00000000000..73b91ef47c1 --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-on-text-change-listener.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.ui.autocomplete](index.md) / [OnTextChangeListener](./-on-text-change-listener.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L37) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-on-windows-focus-change-listener.md b/docs/api/mozilla.components.ui.autocomplete/-on-windows-focus-change-listener.md new file mode 100644 index 00000000000..93dc3f8946f --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-on-windows-focus-change-listener.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.ui.autocomplete](index.md) / [OnWindowsFocusChangeListener](./-on-windows-focus-change-listener.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L40) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/-text-formatter.md b/docs/api/mozilla.components.ui.autocomplete/-text-formatter.md new file mode 100644 index 00000000000..6999e78dfff --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/-text-formatter.md @@ -0,0 +1,5 @@ +[android-components](../index.md) / [mozilla.components.ui.autocomplete](index.md) / [TextFormatter](./-text-formatter.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/autocomplete/src/main/java/mozilla/components/ui/autocomplete/InlineAutocompleteEditText.kt#L42) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.autocomplete/index.md b/docs/api/mozilla.components.ui.autocomplete/index.md new file mode 100644 index 00000000000..7ab708c59af --- /dev/null +++ b/docs/api/mozilla.components.ui.autocomplete/index.md @@ -0,0 +1,23 @@ +[android-components](../index.md) / [mozilla.components.ui.autocomplete](./index.md) + +## Package mozilla.components.ui.autocomplete + +### Types + +| Name | Summary | +|---|---| +| [AutocompleteView](-autocomplete-view/index.md) | `interface AutocompleteView`
Aids in testing functionality which relies on some aspects of InlineAutocompleteEditText. | +| [InlineAutocompleteEditText](-inline-autocomplete-edit-text/index.md) | `open class InlineAutocompleteEditText : AppCompatEditText, `[`AutocompleteView`](-autocomplete-view/index.md)
A UI edit text component which supports inline autocompletion. | + +### Type Aliases + +| Name | Summary | +|---|---| +| [OnCommitListener](-on-commit-listener.md) | `typealias OnCommitListener = () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [OnFilterListener](-on-filter-listener.md) | `typealias OnFilterListener = (`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`) -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [OnKeyPreImeListener](-on-key-pre-ime-listener.md) | `typealias OnKeyPreImeListener = (`[`View`](https://developer.android.com/reference/android/view/View.html)`, `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `[`KeyEvent`](https://developer.android.com/reference/android/view/KeyEvent.html)`) -> `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [OnSearchStateChangeListener](-on-search-state-change-listener.md) | `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.md) | `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.md) | `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.md) | `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.md) | `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/mozilla.components.ui.doorhanger/-doorhanger/-init-.md b/docs/api/mozilla.components.ui.doorhanger/-doorhanger/-init-.md new file mode 100644 index 00000000000..23ae26d7dff --- /dev/null +++ b/docs/api/mozilla.components.ui.doorhanger/-doorhanger/-init-.md @@ -0,0 +1,9 @@ +[android-components](../../index.md) / [mozilla.components.ui.doorhanger](../index.md) / [Doorhanger](index.md) / [<init>](./-init-.md) + +# <init> + +`Doorhanger(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`, onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null)` + +A [Doorhanger](index.md) is a floating heads-up popup that can be anchored to a view. They are presented to notify the user +of something that is important. + diff --git a/docs/api/mozilla.components.ui.doorhanger/-doorhanger/dismiss.md b/docs/api/mozilla.components.ui.doorhanger/-doorhanger/dismiss.md new file mode 100644 index 00000000000..d8f4ca47a3e --- /dev/null +++ b/docs/api/mozilla.components.ui.doorhanger/-doorhanger/dismiss.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.ui.doorhanger](../index.md) / [Doorhanger](index.md) / [dismiss](./dismiss.md) + +# dismiss + +`fun dismiss(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/doorhanger/src/main/java/mozilla/components/ui/doorhanger/Doorhanger.kt#L50) + +Dismiss this doorhanger if it is currently showing. + diff --git a/docs/api/mozilla.components.ui.doorhanger/-doorhanger/index.md b/docs/api/mozilla.components.ui.doorhanger/-doorhanger/index.md new file mode 100644 index 00000000000..33e7662b3e4 --- /dev/null +++ b/docs/api/mozilla.components.ui.doorhanger/-doorhanger/index.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [mozilla.components.ui.doorhanger](../index.md) / [Doorhanger](./index.md) + +# Doorhanger + +`class Doorhanger` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/doorhanger/src/main/java/mozilla/components/ui/doorhanger/Doorhanger.kt#L21) + +A [Doorhanger](./index.md) is a floating heads-up popup that can be anchored to a view. They are presented to notify the user +of something that is important. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Doorhanger(view: `[`View`](https://developer.android.com/reference/android/view/View.html)`, onDismiss: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` = null)`
A [Doorhanger](./index.md) is a floating heads-up popup that can be anchored to a view. They are presented to notify the user of something that is important. | + +### Functions + +| Name | Summary | +|---|---| +| [dismiss](dismiss.md) | `fun dismiss(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Dismiss this doorhanger if it is currently showing. | +| [show](show.md) | `fun show(anchor: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`PopupWindow`](https://developer.android.com/reference/android/widget/PopupWindow.html)
Show this doorhanger and anchor it to the given [View](https://developer.android.com/reference/android/view/View.html). | diff --git a/docs/api/mozilla.components.ui.doorhanger/-doorhanger/show.md b/docs/api/mozilla.components.ui.doorhanger/-doorhanger/show.md new file mode 100644 index 00000000000..1879af2fb38 --- /dev/null +++ b/docs/api/mozilla.components.ui.doorhanger/-doorhanger/show.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.ui.doorhanger](../index.md) / [Doorhanger](index.md) / [show](./show.md) + +# show + +`fun show(anchor: `[`View`](https://developer.android.com/reference/android/view/View.html)`): `[`PopupWindow`](https://developer.android.com/reference/android/widget/PopupWindow.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/doorhanger/src/main/java/mozilla/components/ui/doorhanger/Doorhanger.kt#L30) + +Show this doorhanger and anchor it to the given [View](https://developer.android.com/reference/android/view/View.html). + diff --git a/docs/api/mozilla.components.ui.doorhanger/index.md b/docs/api/mozilla.components.ui.doorhanger/index.md new file mode 100644 index 00000000000..fc56e599ae3 --- /dev/null +++ b/docs/api/mozilla.components.ui.doorhanger/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.ui.doorhanger](./index.md) + +## Package mozilla.components.ui.doorhanger + +### Types + +| Name | Summary | +|---|---| +| [Doorhanger](-doorhanger/index.md) | `class Doorhanger`
A [Doorhanger](-doorhanger/index.md) is a floating heads-up popup that can be anchored to a view. They are presented to notify the user of something that is important. | diff --git a/docs/api/mozilla.components.ui.progress/-animated-progress-bar/-init-.md b/docs/api/mozilla.components.ui.progress/-animated-progress-bar/-init-.md new file mode 100644 index 00000000000..f67b6150e32 --- /dev/null +++ b/docs/api/mozilla.components.ui.progress/-animated-progress-bar/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.ui.progress](../index.md) / [AnimatedProgressBar](index.md) / [<init>](./-init-.md) + +# <init> + +`AnimatedProgressBar(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = 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/mozilla.components.ui.progress/-animated-progress-bar/index.md b/docs/api/mozilla.components.ui.progress/-animated-progress-bar/index.md new file mode 100644 index 00000000000..6b343b11b1f --- /dev/null +++ b/docs/api/mozilla.components.ui.progress/-animated-progress-bar/index.md @@ -0,0 +1,39 @@ +[android-components](../../index.md) / [mozilla.components.ui.progress](../index.md) / [AnimatedProgressBar](./index.md) + +# AnimatedProgressBar + +`open class AnimatedProgressBar : `[`ProgressBar`](https://developer.android.com/reference/android/widget/ProgressBar.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/progress/src/main/java/mozilla/components/ui/progress/AnimatedProgressBar.kt#L23) + +An animated progress bar following the Photon Design System. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `AnimatedProgressBar(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = 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 + +| Name | Summary | +|---|---| +| [onDraw](on-draw.md) | `open fun onDraw(canvas: `[`Canvas`](https://developer.android.com/reference/android/graphics/Canvas.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [setProgress](set-progress.md) | `open 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.md) | `open 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. | + +### Extension Properties + +| Name | Summary | +|---|---| +| [isLTR](../../mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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? | + +### Extension Functions + +| Name | Summary | +|---|---| +| [hideKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.hideKeyboard(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Hides the soft input window. | +| [isGone](../../mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [isVisible](../../mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [setPadding](../../mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.setPadding(padding: `[`Padding`](../../mozilla.components.support.base.android/-padding/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Set a padding using [Padding](../../mozilla.components.support.base.android/-padding/index.md) object. | +| [showKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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/mozilla.components.ui.progress/-animated-progress-bar/on-draw.md b/docs/api/mozilla.components.ui.progress/-animated-progress-bar/on-draw.md new file mode 100644 index 00000000000..153c40baf28 --- /dev/null +++ b/docs/api/mozilla.components.ui.progress/-animated-progress-bar/on-draw.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.progress](../index.md) / [AnimatedProgressBar](index.md) / [onDraw](./on-draw.md) + +# onDraw + +`protected open fun onDraw(canvas: `[`Canvas`](https://developer.android.com/reference/android/graphics/Canvas.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/progress/src/main/java/mozilla/components/ui/progress/AnimatedProgressBar.kt#L67) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.progress/-animated-progress-bar/set-progress.md b/docs/api/mozilla.components.ui.progress/-animated-progress-bar/set-progress.md new file mode 100644 index 00000000000..c5babd3b6dd --- /dev/null +++ b/docs/api/mozilla.components.ui.progress/-animated-progress-bar/set-progress.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.ui.progress](../index.md) / [AnimatedProgressBar](index.md) / [setProgress](./set-progress.md) + +# setProgress + +`open 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/progress/src/main/java/mozilla/components/ui/progress/AnimatedProgressBar.kt#L42) + +Sets the current progress to the specified value. + diff --git a/docs/api/mozilla.components.ui.progress/-animated-progress-bar/set-visibility.md b/docs/api/mozilla.components.ui.progress/-animated-progress-bar/set-visibility.md new file mode 100644 index 00000000000..bc2eb5825d6 --- /dev/null +++ b/docs/api/mozilla.components.ui.progress/-animated-progress-bar/set-visibility.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [mozilla.components.ui.progress](../index.md) / [AnimatedProgressBar](index.md) / [setVisibility](./set-visibility.md) + +# setVisibility + +`open 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/progress/src/main/java/mozilla/components/ui/progress/AnimatedProgressBar.kt#L92) + +Set the visibility state of this view. + diff --git a/docs/api/mozilla.components.ui.progress/index.md b/docs/api/mozilla.components.ui.progress/index.md new file mode 100644 index 00000000000..ec4def9c0f3 --- /dev/null +++ b/docs/api/mozilla.components.ui.progress/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.ui.progress](./index.md) + +## Package mozilla.components.ui.progress + +### Types + +| Name | Summary | +|---|---| +| [AnimatedProgressBar](-animated-progress-bar/index.md) | `open class AnimatedProgressBar : `[`ProgressBar`](https://developer.android.com/reference/android/widget/ProgressBar.html)
An animated progress bar following the Photon Design System. | diff --git a/docs/api/mozilla.components.ui.tabcounter/-tab-counter/-init-.md b/docs/api/mozilla.components.ui.tabcounter/-tab-counter/-init-.md new file mode 100644 index 00000000000..a9b271e7789 --- /dev/null +++ b/docs/api/mozilla.components.ui.tabcounter/-tab-counter/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.tabcounter](../index.md) / [TabCounter](index.md) / [<init>](./-init-.md) + +# <init> + +`TabCounter(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = 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/mozilla.components.ui.tabcounter/-tab-counter/get-text.md b/docs/api/mozilla.components.ui.tabcounter/-tab-counter/get-text.md new file mode 100644 index 00000000000..3321e088905 --- /dev/null +++ b/docs/api/mozilla.components.ui.tabcounter/-tab-counter/get-text.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.tabcounter](../index.md) / [TabCounter](index.md) / [getText](./get-text.md) + +# getText + +`fun getText(): `[`CharSequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/tabcounter/src/main/java/mozilla/components/ui/tabcounter/TabCounter.kt#L62) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.tabcounter/-tab-counter/index.md b/docs/api/mozilla.components.ui.tabcounter/-tab-counter/index.md new file mode 100644 index 00000000000..a459f4a5320 --- /dev/null +++ b/docs/api/mozilla.components.ui.tabcounter/-tab-counter/index.md @@ -0,0 +1,38 @@ +[android-components](../../index.md) / [mozilla.components.ui.tabcounter](../index.md) / [TabCounter](./index.md) + +# TabCounter + +`open class TabCounter : `[`RelativeLayout`](https://developer.android.com/reference/android/widget/RelativeLayout.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/tabcounter/src/main/java/mozilla/components/ui/tabcounter/TabCounter.kt#L22) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TabCounter(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`, attrs: `[`AttributeSet`](https://developer.android.com/reference/android/util/AttributeSet.html)`? = null, defStyle: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = 0)` | + +### Functions + +| Name | Summary | +|---|---| +| [getText](get-text.md) | `fun getText(): `[`CharSequence`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html) | +| [setCount](set-count.md) | `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.md) | `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) | + +### Extension Properties + +| Name | Summary | +|---|---| +| [isLTR](../../mozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md) | `val `[`View`](https://developer.android.com/reference/android/view/View.html)`.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? | + +### Extension Functions + +| Name | Summary | +|---|---| +| [forEach](../../mozilla.components.support.ktx.android.view/android.view.-view-group/for-each.md) | `fun `[`ViewGroup`](https://developer.android.com/reference/android/view/ViewGroup.html)`.forEach(action: (`[`View`](https://developer.android.com/reference/android/view/View.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 the given action on each View in this ViewGroup. | +| [hideKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.hideKeyboard(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Hides the soft input window. | +| [isGone](../../mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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](../../mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [isVisible](../../mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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. | +| [setPadding](../../mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.setPadding(padding: `[`Padding`](../../mozilla.components.support.base.android/-padding/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Set a padding using [Padding](../../mozilla.components.support.base.android/-padding/index.md) object. | +| [showKeyboard](../../mozilla.components.support.ktx.android.view/android.view.-view/show-keyboard.md) | `fun `[`View`](https://developer.android.com/reference/android/view/View.html)`.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/mozilla.components.ui.tabcounter/-tab-counter/set-count-with-animation.md b/docs/api/mozilla.components.ui.tabcounter/-tab-counter/set-count-with-animation.md new file mode 100644 index 00000000000..55287fce578 --- /dev/null +++ b/docs/api/mozilla.components.ui.tabcounter/-tab-counter/set-count-with-animation.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.tabcounter](../index.md) / [TabCounter](index.md) / [setCountWithAnimation](./set-count-with-animation.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/tabcounter/src/main/java/mozilla/components/ui/tabcounter/TabCounter.kt#L66) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.tabcounter/-tab-counter/set-count.md b/docs/api/mozilla.components.ui.tabcounter/-tab-counter/set-count.md new file mode 100644 index 00000000000..b0571848645 --- /dev/null +++ b/docs/api/mozilla.components.ui.tabcounter/-tab-counter/set-count.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [mozilla.components.ui.tabcounter](../index.md) / [TabCounter](index.md) / [setCount](./set-count.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/ui/tabcounter/src/main/java/mozilla/components/ui/tabcounter/TabCounter.kt#L97) \ No newline at end of file diff --git a/docs/api/mozilla.components.ui.tabcounter/index.md b/docs/api/mozilla.components.ui.tabcounter/index.md new file mode 100644 index 00000000000..75a2320fdbf --- /dev/null +++ b/docs/api/mozilla.components.ui.tabcounter/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [mozilla.components.ui.tabcounter](./index.md) + +## Package mozilla.components.ui.tabcounter + +### Types + +| Name | Summary | +|---|---| +| [TabCounter](-tab-counter/index.md) | `open class TabCounter : `[`RelativeLayout`](https://developer.android.com/reference/android/widget/RelativeLayout.html) | diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/-init-.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/-init-.md new file mode 100644 index 00000000000..53951abaae9 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [<init>](./-init-.md) + +# <init> + +`TelemetryConfiguration(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-app-name.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-app-name.md new file mode 100644 index 00000000000..09653c30eb2 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-app-name.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getAppName](./get-app-name.md) + +# getAppName + +`open fun getAppName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L288) + +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/org.mozilla.telemetry.config/-telemetry-configuration/get-app-version.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-app-version.md new file mode 100644 index 00000000000..ead66f29304 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-app-version.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getAppVersion](./get-app-version.md) + +# getAppVersion + +`open fun getAppVersion(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L322) + +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/org.mozilla.telemetry.config/-telemetry-configuration/get-build-id.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-build-id.md new file mode 100644 index 00000000000..e21663c1bac --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-build-id.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getBuildId](./get-build-id.md) + +# getBuildId + +`open fun getBuildId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L339) + +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/org.mozilla.telemetry.config/-telemetry-configuration/get-class-load-timestamp-millis.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-class-load-timestamp-millis.md new file mode 100644 index 00000000000..6d50c6a2de1 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-class-load-timestamp-millis.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getClassLoadTimestampMillis](./get-class-load-timestamp-millis.md) + +# getClassLoadTimestampMillis + +`open fun getClassLoadTimestampMillis(): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L417) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-connect-timeout.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-connect-timeout.md new file mode 100644 index 00000000000..2a490128154 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-connect-timeout.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getConnectTimeout](./get-connect-timeout.md) + +# getConnectTimeout + +`open fun getConnectTimeout(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L181) + +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/org.mozilla.telemetry.config/-telemetry-configuration/get-context.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-context.md new file mode 100644 index 00000000000..69baad79753 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-context.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getContext](./get-context.md) + +# getContext + +`open fun getContext(): `[`Context`](https://developer.android.com/reference/android/content/Context.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L89) + +Application context this library is running in. + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-data-directory.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-data-directory.md new file mode 100644 index 00000000000..cf01028d91b --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-data-directory.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getDataDirectory](./get-data-directory.md) + +# getDataDirectory + +`open fun getDataDirectory(): `[`File`](https://developer.android.com/reference/java/io/File.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L115) + +Get the root directory where telemetry components should store data. + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-initial-backoff-for-upload.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-initial-backoff-for-upload.md new file mode 100644 index 00000000000..a3782532652 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-initial-backoff-for-upload.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getInitialBackoffForUpload](./get-initial-backoff-for-upload.md) + +# getInitialBackoffForUpload + +`open fun getInitialBackoffForUpload(): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L165) + +Get the interval (in milliseconds) to wait initially after a ping upload has failed. + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-events-per-ping.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-events-per-ping.md new file mode 100644 index 00000000000..f468985d711 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-events-per-ping.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getMaximumNumberOfEventsPerPing](./get-maximum-number-of-events-per-ping.md) + +# getMaximumNumberOfEventsPerPing + +`open fun getMaximumNumberOfEventsPerPing(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L364) + +Get the maximum number of events per ping. + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-ping-uploads-per-day.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-ping-uploads-per-day.md new file mode 100644 index 00000000000..e751ac824d6 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-ping-uploads-per-day.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getMaximumNumberOfPingUploadsPerDay](./get-maximum-number-of-ping-uploads-per-day.md) + +# getMaximumNumberOfPingUploadsPerDay + +`open fun getMaximumNumberOfPingUploadsPerDay(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L388) + +Get the maximum number of pings that should be uploaded per day. + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-pings-per-type.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-pings-per-type.md new file mode 100644 index 00000000000..6a09c1718cd --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-maximum-number-of-pings-per-type.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getMaximumNumberOfPingsPerType](./get-maximum-number-of-pings-per-type.md) + +# getMaximumNumberOfPingsPerType + +`open fun getMaximumNumberOfPingsPerType(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L381) + +Get the maximum number of pings that will be stored (for upload). + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-minimum-events-for-upload.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-minimum-events-for-upload.md new file mode 100644 index 00000000000..f89ecf22813 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-minimum-events-for-upload.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getMinimumEventsForUpload](./get-minimum-events-for-upload.md) + +# getMinimumEventsForUpload + +`open fun getMinimumEventsForUpload(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L235) + +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/org.mozilla.telemetry.config/-telemetry-configuration/get-preferences-important-for-telemetry.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-preferences-important-for-telemetry.md new file mode 100644 index 00000000000..e66cc1c1e3c --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-preferences-important-for-telemetry.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getPreferencesImportantForTelemetry](./get-preferences-important-for-telemetry.md) + +# 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)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L158) + +Get a list of preference keys that are important for telemetry. + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-read-timeout.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-read-timeout.md new file mode 100644 index 00000000000..4f03d7761a9 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-read-timeout.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getReadTimeout](./get-read-timeout.md) + +# getReadTimeout + +`open fun getReadTimeout(): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L189) + +Returns setting for read timeout. 0 return implies that the option is disabled (i.e., timeout of infinity). + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-server-endpoint.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-server-endpoint.md new file mode 100644 index 00000000000..b8c20a23578 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-server-endpoint.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getServerEndpoint](./get-server-endpoint.md) + +# getServerEndpoint + +`open fun getServerEndpoint(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L131) + +Set the server endpoint to upload telemetry pings to. + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-settings-provider.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-settings-provider.md new file mode 100644 index 00000000000..f463b6c37f5 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-settings-provider.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getSettingsProvider](./get-settings-provider.md) + +# getSettingsProvider + +`open fun getSettingsProvider(): `[`SettingsProvider`](../../org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L405) + +Get the provider for reading app settings. + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-shared-preferences.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-shared-preferences.md new file mode 100644 index 00000000000..ddebd9be59e --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-shared-preferences.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getSharedPreferences](./get-shared-preferences.md) + +# getSharedPreferences + +`open fun getSharedPreferences(): `[`SharedPreferences`](https://developer.android.com/reference/android/content/SharedPreferences.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L138) + +Get shared preference for storing telemetry related data. + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-update-channel.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-update-channel.md new file mode 100644 index 00000000000..01403a98e65 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-update-channel.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getUpdateChannel](./get-update-channel.md) + +# getUpdateChannel + +`open fun getUpdateChannel(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L314) + +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/org.mozilla.telemetry.config/-telemetry-configuration/get-user-agent.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-user-agent.md new file mode 100644 index 00000000000..58b728233f5 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/get-user-agent.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [getUserAgent](./get-user-agent.md) + +# getUserAgent + +`open fun getUserAgent(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L219) + +Get the user agent used when communicating with the telemetry endpoint. + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/index.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/index.md new file mode 100644 index 00000000000..6b74966e16a --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/index.md @@ -0,0 +1,57 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](./index.md) + +# TelemetryConfiguration + +`open class TelemetryConfiguration` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L25) + +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 + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TelemetryConfiguration(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [getAppName](get-app-name.md) | `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.md) | `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.md) | `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.md) | `open fun getClassLoadTimestampMillis(): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | +| [getConnectTimeout](get-connect-timeout.md) | `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.md) | `open fun getContext(): `[`Context`](https://developer.android.com/reference/android/content/Context.html)
Application context this library is running in. | +| [getDataDirectory](get-data-directory.md) | `open fun getDataDirectory(): `[`File`](https://developer.android.com/reference/java/io/File.html)
Get the root directory where telemetry components should store data. | +| [getInitialBackoffForUpload](get-initial-backoff-for-upload.md) | `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.md) | `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.md) | `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.md) | `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.md) | `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.md) | `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.md) | `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.md) | `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.md) | `open fun getSettingsProvider(): `[`SettingsProvider`](../../org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/index.md)
Get the provider for reading app settings. | +| [getSharedPreferences](get-shared-preferences.md) | `open fun getSharedPreferences(): `[`SharedPreferences`](https://developer.android.com/reference/android/content/SharedPreferences.html)
Get shared preference for storing telemetry related data. | +| [getUpdateChannel](get-update-channel.md) | `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.md) | `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.md) | `open fun isCollectionEnabled(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is collecting telemetry data enabled? | +| [isUploadEnabled](is-upload-enabled.md) | `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.md) | `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.md) | `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.md) | `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.md) | `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.md) | `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.md) | `open fun setDataDirectory(dataDirectory: `[`File`](https://developer.android.com/reference/java/io/File.html)`): `[`TelemetryConfiguration`](./index.md)
Set the root directory where telemetry components should store data. | +| [setInitialBackoffForUpload](set-initial-backoff-for-upload.md) | `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.md) | `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.md) | `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.md) | `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.md) | `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.md) | `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.md) | `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.md) | `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.md) | `open fun setSettingsProvider(settingsProvider: `[`SettingsProvider`](../../org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/index.md)`): `[`TelemetryConfiguration`](./index.md)
Set a provider for reading app settings. | +| [setUpdateChannel](set-update-channel.md) | `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.md) | `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.md) | `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/org.mozilla.telemetry.config/-telemetry-configuration/is-collection-enabled.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/is-collection-enabled.md new file mode 100644 index 00000000000..61917dd6def --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/is-collection-enabled.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [isCollectionEnabled](./is-collection-enabled.md) + +# isCollectionEnabled + +`open fun isCollectionEnabled(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L255) + +Is collecting telemetry data enabled? + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/is-upload-enabled.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/is-upload-enabled.md new file mode 100644 index 00000000000..39446d0b97b --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/is-upload-enabled.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [isUploadEnabled](./is-upload-enabled.md) + +# isUploadEnabled + +`open fun isUploadEnabled(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L280) + +Is uploading collected telemetry data enable? + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-app-name.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-app-name.md new file mode 100644 index 00000000000..c027e2e7887 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-app-name.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setAppName](./set-app-name.md) + +# setAppName + +`open fun setAppName(appName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L296) + +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/org.mozilla.telemetry.config/-telemetry-configuration/set-app-version.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-app-version.md new file mode 100644 index 00000000000..579d408b61d --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-app-version.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setAppVersion](./set-app-version.md) + +# setAppVersion + +`open fun setAppVersion(appVersion: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L330) + +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/org.mozilla.telemetry.config/-telemetry-configuration/set-build-id.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-build-id.md new file mode 100644 index 00000000000..6f5693ad83d --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-build-id.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setBuildId](./set-build-id.md) + +# setBuildId + +`open fun setBuildId(buildId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L347) + +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/org.mozilla.telemetry.config/-telemetry-configuration/set-collection-enabled.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-collection-enabled.md new file mode 100644 index 00000000000..d89cc6f1a43 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-collection-enabled.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setCollectionEnabled](./set-collection-enabled.md) + +# setCollectionEnabled + +`open fun setCollectionEnabled(collectionEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L263) + +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/org.mozilla.telemetry.config/-telemetry-configuration/set-connect-timeout.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-connect-timeout.md new file mode 100644 index 00000000000..62e3da94958 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-connect-timeout.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setConnectTimeout](./set-connect-timeout.md) + +# setConnectTimeout + +`open fun setConnectTimeout(connectTimeout: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L200) + +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/org.mozilla.telemetry.config/-telemetry-configuration/set-data-directory.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-data-directory.md new file mode 100644 index 00000000000..41f77b6d45d --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-data-directory.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setDataDirectory](./set-data-directory.md) + +# setDataDirectory + +`open fun setDataDirectory(dataDirectory: `[`File`](https://developer.android.com/reference/java/io/File.html)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L96) + +Set the root directory where telemetry components should store data. + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-initial-backoff-for-upload.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-initial-backoff-for-upload.md new file mode 100644 index 00000000000..0d957c809c3 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-initial-backoff-for-upload.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setInitialBackoffForUpload](./set-initial-backoff-for-upload.md) + +# setInitialBackoffForUpload + +`open fun setInitialBackoffForUpload(initialBackoffForUpload: `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L172) + +Set the interval (in milliseconds) to wait initially after a ping upload has failed. + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-events-per-ping.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-events-per-ping.md new file mode 100644 index 00000000000..7a73c225ae9 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-events-per-ping.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setMaximumNumberOfEventsPerPing](./set-maximum-number-of-events-per-ping.md) + +# setMaximumNumberOfEventsPerPing + +`open fun setMaximumNumberOfEventsPerPing(maximumNumberOfEventsPerPing: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L356) + +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/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-ping-uploads-per-day.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-ping-uploads-per-day.md new file mode 100644 index 00000000000..079af995c98 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-ping-uploads-per-day.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setMaximumNumberOfPingUploadsPerDay](./set-maximum-number-of-ping-uploads-per-day.md) + +# setMaximumNumberOfPingUploadsPerDay + +`open fun setMaximumNumberOfPingUploadsPerDay(maximumNumberOfPingUploadsPerDay: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L397) + +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/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-pings-per-type.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-pings-per-type.md new file mode 100644 index 00000000000..c173df051fa --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-maximum-number-of-pings-per-type.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setMaximumNumberOfPingsPerType](./set-maximum-number-of-pings-per-type.md) + +# setMaximumNumberOfPingsPerType + +`open fun setMaximumNumberOfPingsPerType(maximumNumberOfPingsPerType: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L373) + +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/org.mozilla.telemetry.config/-telemetry-configuration/set-minimum-events-for-upload.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-minimum-events-for-upload.md new file mode 100644 index 00000000000..44efb7e8fc8 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-minimum-events-for-upload.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setMinimumEventsForUpload](./set-minimum-events-for-upload.md) + +# setMinimumEventsForUpload + +`open fun setMinimumEventsForUpload(minimumEventsForUpload: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L243) + +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/org.mozilla.telemetry.config/-telemetry-configuration/set-preferences-important-for-telemetry.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-preferences-important-for-telemetry.md new file mode 100644 index 00000000000..c53c8efd507 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-preferences-important-for-telemetry.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setPreferencesImportantForTelemetry](./set-preferences-important-for-telemetry.md) + +# setPreferencesImportantForTelemetry + +`open fun setPreferencesImportantForTelemetry(vararg preferences: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L146) + +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/org.mozilla.telemetry.config/-telemetry-configuration/set-read-timeout.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-read-timeout.md new file mode 100644 index 00000000000..169c6d160a7 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-read-timeout.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setReadTimeout](./set-read-timeout.md) + +# setReadTimeout + +`open fun setReadTimeout(readTimeout: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L211) + +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/org.mozilla.telemetry.config/-telemetry-configuration/set-server-endpoint.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-server-endpoint.md new file mode 100644 index 00000000000..c524bc3a5ac --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-server-endpoint.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setServerEndpoint](./set-server-endpoint.md) + +# setServerEndpoint + +`open fun setServerEndpoint(endpoint: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L123) + +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/org.mozilla.telemetry.config/-telemetry-configuration/set-settings-provider.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-settings-provider.md new file mode 100644 index 00000000000..0782ca261e4 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-settings-provider.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setSettingsProvider](./set-settings-provider.md) + +# setSettingsProvider + +`open fun setSettingsProvider(settingsProvider: `[`SettingsProvider`](../../org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/index.md)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L412) + +Set a provider for reading app settings. + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-update-channel.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-update-channel.md new file mode 100644 index 00000000000..df116a703d4 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-update-channel.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setUpdateChannel](./set-update-channel.md) + +# setUpdateChannel + +`open fun setUpdateChannel(updateChannel: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L305) + +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/org.mozilla.telemetry.config/-telemetry-configuration/set-upload-enabled.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-upload-enabled.md new file mode 100644 index 00000000000..9be11dcdaff --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-upload-enabled.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setUploadEnabled](./set-upload-enabled.md) + +# setUploadEnabled + +`open fun setUploadEnabled(uploadEnabled: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L272) + +Enable or disable the upload of collected telemetry data. This is usually set based on a user visible preference. + diff --git a/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-user-agent.md b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-user-agent.md new file mode 100644 index 00000000000..5b16ce33c35 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/-telemetry-configuration/set-user-agent.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.config](../index.md) / [TelemetryConfiguration](index.md) / [setUserAgent](./set-user-agent.md) + +# setUserAgent + +`open fun setUserAgent(userAgent: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryConfiguration`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/config/TelemetryConfiguration.java#L226) + +Set the user agent used when communicating with the telemetry endpoint. + diff --git a/docs/api/org.mozilla.telemetry.config/index.md b/docs/api/org.mozilla.telemetry.config/index.md new file mode 100644 index 00000000000..b1b1255ffdf --- /dev/null +++ b/docs/api/org.mozilla.telemetry.config/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [org.mozilla.telemetry.config](./index.md) + +## Package org.mozilla.telemetry.config + +### Types + +| Name | Summary | +|---|---| +| [TelemetryConfiguration](-telemetry-configuration/index.md) | `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/org.mozilla.telemetry.event/-telemetry-event/create.md b/docs/api/org.mozilla.telemetry.event/-telemetry-event/create.md new file mode 100644 index 00000000000..527775f1d44 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.event/-telemetry-event/create.md @@ -0,0 +1,27 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.event](../index.md) / [TelemetryEvent](index.md) / [create](./create.md) + +# 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.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/event/TelemetryEvent.java#L45) + +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.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/event/TelemetryEvent.java#L58) + +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/org.mozilla.telemetry.event/-telemetry-event/extra.md b/docs/api/org.mozilla.telemetry.event/-telemetry-event/extra.md new file mode 100644 index 00000000000..859b4b61778 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.event/-telemetry-event/extra.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.event](../index.md) / [TelemetryEvent](index.md) / [extra](./extra.md) + +# 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.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/event/TelemetryEvent.java#L106) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.event/-telemetry-event/index.md b/docs/api/org.mozilla.telemetry.event/-telemetry-event/index.md new file mode 100644 index 00000000000..6483206979b --- /dev/null +++ b/docs/api/org.mozilla.telemetry.event/-telemetry-event/index.md @@ -0,0 +1,16 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.event](../index.md) / [TelemetryEvent](./index.md) + +# TelemetryEvent + +`open class TelemetryEvent` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/event/TelemetryEvent.java#L26) + +TelemetryEvent specifies a common events data format, which allows for broader, shared usage of data processing tools. + +### Functions + +| Name | Summary | +|---|---| +| [create](create.md) | `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.md) | `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.md) | `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.md) | `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/org.mozilla.telemetry.event/-telemetry-event/queue.md b/docs/api/org.mozilla.telemetry.event/-telemetry-event/queue.md new file mode 100644 index 00000000000..8c97b0a2375 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.event/-telemetry-event/queue.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.event](../index.md) / [TelemetryEvent](index.md) / [queue](./queue.md) + +# queue + +`open fun queue(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/event/TelemetryEvent.java#L120) + +Queue this event to be sent with the next event ping. + diff --git a/docs/api/org.mozilla.telemetry.event/-telemetry-event/to-j-s-o-n.md b/docs/api/org.mozilla.telemetry.event/-telemetry-event/to-j-s-o-n.md new file mode 100644 index 00000000000..040ddf1a472 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.event/-telemetry-event/to-j-s-o-n.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.event](../index.md) / [TelemetryEvent](index.md) / [toJSON](./to-j-s-o-n.md) + +# toJSON + +`open fun toJSON(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/event/TelemetryEvent.java#L128) + +Create a JSON representation of this event for storing and sending it. + diff --git a/docs/api/org.mozilla.telemetry.event/index.md b/docs/api/org.mozilla.telemetry.event/index.md new file mode 100644 index 00000000000..261b2ce3cc9 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.event/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [org.mozilla.telemetry.event](./index.md) + +## Package org.mozilla.telemetry.event + +### Types + +| Name | Summary | +|---|---| +| [TelemetryEvent](-telemetry-event/index.md) | `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/org.mozilla.telemetry.measurement/-arch-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-arch-measurement/-init-.md new file mode 100644 index 00000000000..738e781222b --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-arch-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [ArchMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`ArchMeasurement()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-arch-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-arch-measurement/flush.md new file mode 100644 index 00000000000..e047e4e8cea --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-arch-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [ArchMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/ArchMeasurement.java#L20) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-arch-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-arch-measurement/index.md new file mode 100644 index 00000000000..52e5ca75505 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-arch-measurement/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [ArchMeasurement](./index.md) + +# ArchMeasurement + +`open class ArchMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/ArchMeasurement.java#L12) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ArchMeasurement()` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-client-id-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-client-id-measurement/-init-.md new file mode 100644 index 00000000000..942196f12af --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-client-id-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [ClientIdMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`ClientIdMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-client-id-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-client-id-measurement/flush.md new file mode 100644 index 00000000000..76d02221b86 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-client-id-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [ClientIdMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/ClientIdMeasurement.java#L31) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-client-id-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-client-id-measurement/index.md new file mode 100644 index 00000000000..9a033fc276a --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-client-id-measurement/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [ClientIdMeasurement](./index.md) + +# ClientIdMeasurement + +`open class ClientIdMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/ClientIdMeasurement.java#L16) + +A unique, randomly generated UUID for this client. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ClientIdMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement-new/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement-new/-init-.md new file mode 100644 index 00000000000..753dbe1a971 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement-new/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [CreatedDateMeasurementNew](index.md) / [<init>](./-init-.md) + +# <init> + +`CreatedDateMeasurementNew()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement-new/flush.md b/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement-new/flush.md new file mode 100644 index 00000000000..40f66912c1d --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement-new/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [CreatedDateMeasurementNew](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/CreatedDateMeasurementNew.java#L23) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement-new/index.md b/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement-new/index.md new file mode 100644 index 00000000000..51bae8d69ce --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement-new/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [CreatedDateMeasurementNew](./index.md) + +# CreatedDateMeasurementNew + +`open class CreatedDateMeasurementNew : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/CreatedDateMeasurementNew.java#L15) + +The field 'created' from CreatedDateMeasurement will be deprecated for the `createdDate` field + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `CreatedDateMeasurementNew()` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement/-init-.md new file mode 100644 index 00000000000..b5d9fd0cff3 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [CreatedDateMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`CreatedDateMeasurement()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement/flush.md new file mode 100644 index 00000000000..fd07232cb50 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [CreatedDateMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/CreatedDateMeasurement.java#L20) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement/index.md new file mode 100644 index 00000000000..1234cdfada3 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-created-date-measurement/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [CreatedDateMeasurement](./index.md) + +# CreatedDateMeasurement + +`open class CreatedDateMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/CreatedDateMeasurement.java#L12) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `CreatedDateMeasurement()` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/-init-.md new file mode 100644 index 00000000000..a112d901815 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [CreatedTimestampMeasurementNew](index.md) / [<init>](./-init-.md) + +# <init> + +`CreatedTimestampMeasurementNew()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/flush.md b/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/flush.md new file mode 100644 index 00000000000..22606849c3e --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [CreatedTimestampMeasurementNew](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/CreatedTimestampMeasurementNew.java#L18) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/index.md b/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/index.md new file mode 100644 index 00000000000..316cfc3f214 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement-new/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [CreatedTimestampMeasurementNew](./index.md) + +# CreatedTimestampMeasurementNew + +`open class CreatedTimestampMeasurementNew : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/CreatedTimestampMeasurementNew.java#L10) + +The field 'created' from CreatedTimestampMeasurement will be deprecated for the `createdTimestamp` field + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `CreatedTimestampMeasurementNew()` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement/-init-.md new file mode 100644 index 00000000000..d8c8da07c11 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [CreatedTimestampMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`CreatedTimestampMeasurement()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement/flush.md new file mode 100644 index 00000000000..57d78adb699 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [CreatedTimestampMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/CreatedTimestampMeasurement.java#L15) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement/index.md new file mode 100644 index 00000000000..145890a09e2 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-created-timestamp-measurement/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [CreatedTimestampMeasurement](./index.md) + +# CreatedTimestampMeasurement + +`open class CreatedTimestampMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/CreatedTimestampMeasurement.java#L7) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `CreatedTimestampMeasurement()` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/get-default-search-engine-identifier.md b/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/get-default-search-engine-identifier.md new file mode 100644 index 00000000000..b56830ff156 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/get-default-search-engine-identifier.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.measurement](../../index.md) / [DefaultSearchMeasurement](../index.md) / [DefaultSearchEngineProvider](index.md) / [getDefaultSearchEngineIdentifier](./get-default-search-engine-identifier.md) + +# getDefaultSearchEngineIdentifier + +`abstract fun getDefaultSearchEngineIdentifier(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/DefaultSearchMeasurement.java#L13) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/index.md b/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/index.md new file mode 100644 index 00000000000..1eb1144bcda --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.measurement](../../index.md) / [DefaultSearchMeasurement](../index.md) / [DefaultSearchEngineProvider](./index.md) + +# DefaultSearchEngineProvider + +`interface DefaultSearchEngineProvider` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/DefaultSearchMeasurement.java#L12) + +### Functions + +| Name | Summary | +|---|---| +| [getDefaultSearchEngineIdentifier](get-default-search-engine-identifier.md) | `abstract fun getDefaultSearchEngineIdentifier(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/-init-.md new file mode 100644 index 00000000000..d99114d5072 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [DefaultSearchMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`DefaultSearchMeasurement()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/flush.md new file mode 100644 index 00000000000..49db16b71b9 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [DefaultSearchMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/DefaultSearchMeasurement.java#L27) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/index.md new file mode 100644 index 00000000000..376f94b2c4e --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/index.md @@ -0,0 +1,30 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [DefaultSearchMeasurement](./index.md) + +# DefaultSearchMeasurement + +`open class DefaultSearchMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/DefaultSearchMeasurement.java#L9) + +### Types + +| Name | Summary | +|---|---| +| [DefaultSearchEngineProvider](-default-search-engine-provider/index.md) | `interface DefaultSearchEngineProvider` | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `DefaultSearchMeasurement()` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | +| [setDefaultSearchEngineProvider](set-default-search-engine-provider.md) | `open fun setDefaultSearchEngineProvider(provider: `[`DefaultSearchEngineProvider`](-default-search-engine-provider/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/set-default-search-engine-provider.md b/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/set-default-search-engine-provider.md new file mode 100644 index 00000000000..932285113a1 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-default-search-measurement/set-default-search-engine-provider.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [DefaultSearchMeasurement](index.md) / [setDefaultSearchEngineProvider](./set-default-search-engine-provider.md) + +# setDefaultSearchEngineProvider + +`open fun setDefaultSearchEngineProvider(provider: `[`DefaultSearchEngineProvider`](-default-search-engine-provider/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/DefaultSearchMeasurement.java#L22) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-device-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-device-measurement/-init-.md new file mode 100644 index 00000000000..ee8bdfcca4f --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-device-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [DeviceMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`DeviceMeasurement()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-device-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-device-measurement/flush.md new file mode 100644 index 00000000000..6e1692c61b8 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-device-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [DeviceMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/DeviceMeasurement.java#L21) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-device-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-device-measurement/index.md new file mode 100644 index 00000000000..292a3395a97 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-device-measurement/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [DeviceMeasurement](./index.md) + +# DeviceMeasurement + +`open class DeviceMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/DeviceMeasurement.java#L13) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `DeviceMeasurement()` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-events-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-events-measurement/-init-.md new file mode 100644 index 00000000000..9f8a87e9ef8 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-events-measurement/-init-.md @@ -0,0 +1,6 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [EventsMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`EventsMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` +`EventsMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`, filename: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-events-measurement/add.md b/docs/api/org.mozilla.telemetry.measurement/-events-measurement/add.md new file mode 100644 index 00000000000..f520244454f --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-events-measurement/add.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [EventsMeasurement](index.md) / [add](./add.md) + +# add + +`open fun add(event: `[`TelemetryEvent`](../../org.mozilla.telemetry.event/-telemetry-event/index.md)`): `[`EventsMeasurement`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/EventsMeasurement.java#L53) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-events-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-events-measurement/flush.md new file mode 100644 index 00000000000..2523ab1e515 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-events-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [EventsMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/EventsMeasurement.java#L59) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-events-measurement/get-event-count.md b/docs/api/org.mozilla.telemetry.measurement/-events-measurement/get-event-count.md new file mode 100644 index 00000000000..e8ea54e4566 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-events-measurement/get-event-count.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [EventsMeasurement](index.md) / [getEventCount](./get-event-count.md) + +# getEventCount + +`open fun getEventCount(): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/EventsMeasurement.java#L153) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-events-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-events-measurement/index.md new file mode 100644 index 00000000000..a1d4e041dd4 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-events-measurement/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [EventsMeasurement](./index.md) + +# EventsMeasurement + +`open class EventsMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/EventsMeasurement.java#L29) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `EventsMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)`
`EventsMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`, filename: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [add](add.md) | `open fun add(event: `[`TelemetryEvent`](../../org.mozilla.telemetry.event/-telemetry-event/index.md)`): `[`EventsMeasurement`](./index.md) | +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | +| [getEventCount](get-event-count.md) | `open fun getEventCount(): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-experiments-map-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-experiments-map-measurement/-init-.md new file mode 100644 index 00000000000..92bae21645a --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-experiments-map-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [ExperimentsMapMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`ExperimentsMapMeasurement()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-experiments-map-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-experiments-map-measurement/flush.md new file mode 100644 index 00000000000..fbc2e905634 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-experiments-map-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [ExperimentsMapMeasurement](index.md) / [flush](./flush.md) + +# flush + +`fun flush(): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/ExperimentsMapMeasurement.kt#L23) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-experiments-map-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-experiments-map-measurement/index.md new file mode 100644 index 00000000000..0768673ded3 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-experiments-map-measurement/index.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [ExperimentsMapMeasurement](./index.md) + +# ExperimentsMapMeasurement + +`class ExperimentsMapMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/ExperimentsMapMeasurement.kt#L14) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ExperimentsMapMeasurement()` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `fun flush(): `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html) | +| [setExperiments](set-experiments.md) | `fun setExperiments(experiments: `[`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)`, `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-experiments-map-measurement/set-experiments.md b/docs/api/org.mozilla.telemetry.measurement/-experiments-map-measurement/set-experiments.md new file mode 100644 index 00000000000..9ce967f10f8 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-experiments-map-measurement/set-experiments.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [ExperimentsMapMeasurement](index.md) / [setExperiments](./set-experiments.md) + +# setExperiments + +`fun setExperiments(experiments: `[`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)`, `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/ExperimentsMapMeasurement.kt#L17) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-experiments-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-experiments-measurement/-init-.md new file mode 100644 index 00000000000..2d4eec10734 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-experiments-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [ExperimentsMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`ExperimentsMeasurement()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-experiments-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-experiments-measurement/flush.md new file mode 100644 index 00000000000..f7ad476a4c1 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-experiments-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [ExperimentsMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/ExperimentsMeasurement.java#L25) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-experiments-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-experiments-measurement/index.md new file mode 100644 index 00000000000..312a6b79572 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-experiments-measurement/index.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [ExperimentsMeasurement](./index.md) + +# ExperimentsMeasurement + +`open class ExperimentsMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/ExperimentsMeasurement.java#L11) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ExperimentsMeasurement()` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | +| [setActiveExperiments](set-active-experiments.md) | `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 + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-experiments-measurement/set-active-experiments.md b/docs/api/org.mozilla.telemetry.measurement/-experiments-measurement/set-active-experiments.md new file mode 100644 index 00000000000..9996743125f --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-experiments-measurement/set-active-experiments.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [ExperimentsMeasurement](index.md) / [setActiveExperiments](./set-active-experiments.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/ExperimentsMeasurement.java#L20) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/-init-.md new file mode 100644 index 00000000000..44e8d549608 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [FirstRunProfileDateMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`FirstRunProfileDateMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/flush.md new file mode 100644 index 00000000000..24154d912f5 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [FirstRunProfileDateMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/FirstRunProfileDateMeasurement.java#L46) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/index.md new file mode 100644 index 00000000000..0e7eaf06901 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-first-run-profile-date-measurement/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [FirstRunProfileDateMeasurement](./index.md) + +# FirstRunProfileDateMeasurement + +`open class FirstRunProfileDateMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/FirstRunProfileDateMeasurement.java#L18) + +This measurement will save the timestamp of the first time it was instantiated and report this as profile creation date. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FirstRunProfileDateMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-locale-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-locale-measurement/-init-.md new file mode 100644 index 00000000000..84b02a55432 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-locale-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [LocaleMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`LocaleMeasurement()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-locale-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-locale-measurement/flush.md new file mode 100644 index 00000000000..ef99994db19 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-locale-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [LocaleMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/LocaleMeasurement.java#L17) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-locale-measurement/get-language-tag.md b/docs/api/org.mozilla.telemetry.measurement/-locale-measurement/get-language-tag.md new file mode 100644 index 00000000000..f4857de7a0b --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-locale-measurement/get-language-tag.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [LocaleMeasurement](index.md) / [getLanguageTag](./get-language-tag.md) + +# getLanguageTag + +`open fun getLanguageTag(locale: `[`Locale`](https://developer.android.com/reference/java/util/Locale.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/LocaleMeasurement.java#L30) + +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/org.mozilla.telemetry.measurement/-locale-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-locale-measurement/index.md new file mode 100644 index 00000000000..87ab1e4bc45 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-locale-measurement/index.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [LocaleMeasurement](./index.md) + +# LocaleMeasurement + +`open class LocaleMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/LocaleMeasurement.java#L9) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `LocaleMeasurement()` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | +| [getLanguageTag](get-language-tag.md) | `open fun getLanguageTag(locale: `[`Locale`](https://developer.android.com/reference/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 + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-metrics-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-metrics-measurement/-init-.md new file mode 100644 index 00000000000..1c0c151f9f5 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-metrics-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [MetricsMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`MetricsMeasurement(snapshot: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-metrics-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-metrics-measurement/flush.md new file mode 100644 index 00000000000..40c915f9a7c --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-metrics-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [MetricsMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/MetricsMeasurement.java#L19) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-metrics-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-metrics-measurement/index.md new file mode 100644 index 00000000000..6ae3c2a7e2e --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-metrics-measurement/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [MetricsMeasurement](./index.md) + +# MetricsMeasurement + +`open class MetricsMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/MetricsMeasurement.java#L9) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `MetricsMeasurement(snapshot: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-operating-system-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-operating-system-measurement/-init-.md new file mode 100644 index 00000000000..33e859a6982 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-operating-system-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [OperatingSystemMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`OperatingSystemMeasurement()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-operating-system-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-operating-system-measurement/index.md new file mode 100644 index 00000000000..fd11c6bf858 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-operating-system-measurement/index.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [OperatingSystemMeasurement](./index.md) + +# OperatingSystemMeasurement + +`open class OperatingSystemMeasurement : `[`StaticMeasurement`](../-static-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/OperatingSystemMeasurement.java#L7) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `OperatingSystemMeasurement()` | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [flush](../-static-measurement/flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-operating-system-version-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-operating-system-version-measurement/-init-.md new file mode 100644 index 00000000000..21ae77f1c23 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-operating-system-version-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [OperatingSystemVersionMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`OperatingSystemVersionMeasurement()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-operating-system-version-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-operating-system-version-measurement/index.md new file mode 100644 index 00000000000..5299e13afad --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-operating-system-version-measurement/index.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [OperatingSystemVersionMeasurement](./index.md) + +# OperatingSystemVersionMeasurement + +`open class OperatingSystemVersionMeasurement : `[`StaticMeasurement`](../-static-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/OperatingSystemVersionMeasurement.java#L9) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `OperatingSystemVersionMeasurement()` | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [flush](../-static-measurement/flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-pocket-id-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-pocket-id-measurement/-init-.md new file mode 100644 index 00000000000..ca833190f32 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-pocket-id-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [PocketIdMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`PocketIdMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-pocket-id-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-pocket-id-measurement/flush.md new file mode 100644 index 00000000000..6faa22f136b --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-pocket-id-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [PocketIdMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/PocketIdMeasurement.java#L32) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-pocket-id-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-pocket-id-measurement/index.md new file mode 100644 index 00000000000..5fcacbfa7e1 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-pocket-id-measurement/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [PocketIdMeasurement](./index.md) + +# PocketIdMeasurement + +`open class PocketIdMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/PocketIdMeasurement.java#L17) + +A unique, randomly generated UUID for this pocket client for fire-tv instance. This is distinct from the telemetry clientId. The clientId should not be able to be tied to the pocketId in any way. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `PocketIdMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/-init-.md new file mode 100644 index 00000000000..ec30bb0e860 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [ProcessStartTimestampMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`ProcessStartTimestampMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/flush.md new file mode 100644 index 00000000000..5924bb77b2d --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [ProcessStartTimestampMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/ProcessStartTimestampMeasurement.java#L20) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/index.md new file mode 100644 index 00000000000..b15e62a178b --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-process-start-timestamp-measurement/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [ProcessStartTimestampMeasurement](./index.md) + +# ProcessStartTimestampMeasurement + +`open class ProcessStartTimestampMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/ProcessStartTimestampMeasurement.java#L6) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ProcessStartTimestampMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-searches-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-searches-measurement/-init-.md new file mode 100644 index 00000000000..7d2459a68d9 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-searches-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SearchesMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`SearchesMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` \ No newline at end of file diff --git a/docs/api/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/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..9b22e4c75e5 --- /dev/null +++ b/docs/api/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,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SearchesMeasurement](index.md) / [LOCATION_ACTIONBAR](./-l-o-c-a-t-i-o-n_-a-c-t-i-o-n-b-a-r.md) + +# LOCATION_ACTIONBAR + +`static val LOCATION_ACTIONBAR: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SearchesMeasurement.java#L28) \ No newline at end of file diff --git a/docs/api/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/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..14d034a7bbd --- /dev/null +++ b/docs/api/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,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SearchesMeasurement](index.md) / [LOCATION_LISTITEM](./-l-o-c-a-t-i-o-n_-l-i-s-t-i-t-e-m.md) + +# LOCATION_LISTITEM + +`static val LOCATION_LISTITEM: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SearchesMeasurement.java#L30) \ No newline at end of file diff --git a/docs/api/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/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..cc3a77fba45 --- /dev/null +++ b/docs/api/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,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SearchesMeasurement](index.md) / [LOCATION_SUGGESTION](./-l-o-c-a-t-i-o-n_-s-u-g-g-e-s-t-i-o-n.md) + +# LOCATION_SUGGESTION + +`static val LOCATION_SUGGESTION: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SearchesMeasurement.java#L29) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-searches-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-searches-measurement/flush.md new file mode 100644 index 00000000000..72062653ae3 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-searches-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SearchesMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SearchesMeasurement.java#L41) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-searches-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-searches-measurement/index.md new file mode 100644 index 00000000000..93bd2d2103f --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-searches-measurement/index.md @@ -0,0 +1,34 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SearchesMeasurement](./index.md) + +# SearchesMeasurement + +`open class SearchesMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SearchesMeasurement.java#L22) + +A TelemetryMeasurement implementation to count the number of times a user has searched with a specific engine from a specific location. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SearchesMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` | + +### Properties + +| Name | Summary | +|---|---| +| [LOCATION_ACTIONBAR](-l-o-c-a-t-i-o-n_-a-c-t-i-o-n-b-a-r.md) | `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.md) | `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.md) | `static val LOCATION_SUGGESTION: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | +| [recordSearch](record-search.md) | `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 + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-searches-measurement/record-search.md b/docs/api/org.mozilla.telemetry.measurement/-searches-measurement/record-search.md new file mode 100644 index 00000000000..d152d7b1254 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-searches-measurement/record-search.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SearchesMeasurement](index.md) / [recordSearch](./record-search.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SearchesMeasurement.java#L78) + +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/org.mozilla.telemetry.measurement/-sequence-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-sequence-measurement/-init-.md new file mode 100644 index 00000000000..7862ed9a394 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-sequence-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SequenceMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`SequenceMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`, ping: `[`TelemetryPingBuilder`](../../org.mozilla.telemetry.ping/-telemetry-ping-builder/index.md)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-sequence-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-sequence-measurement/flush.md new file mode 100644 index 00000000000..77e3ead2bf0 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-sequence-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SequenceMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SequenceMeasurement.java#L28) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-sequence-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-sequence-measurement/index.md new file mode 100644 index 00000000000..1b0126efcc5 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-sequence-measurement/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SequenceMeasurement](./index.md) + +# SequenceMeasurement + +`open class SequenceMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SequenceMeasurement.java#L12) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SequenceMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`, ping: `[`TelemetryPingBuilder`](../../org.mozilla.telemetry.ping/-telemetry-ping-builder/index.md)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-session-count-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-session-count-measurement/-init-.md new file mode 100644 index 00000000000..a202e898956 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-session-count-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SessionCountMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`SessionCountMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-session-count-measurement/count-session.md b/docs/api/org.mozilla.telemetry.measurement/-session-count-measurement/count-session.md new file mode 100644 index 00000000000..31521f0d55b --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-session-count-measurement/count-session.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SessionCountMeasurement](index.md) / [countSession](./count-session.md) + +# countSession + +`open fun countSession(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SessionCountMeasurement.java#L24) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-session-count-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-session-count-measurement/flush.md new file mode 100644 index 00000000000..e1ab82dc65e --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-session-count-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SessionCountMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SessionCountMeasurement.java#L35) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-session-count-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-session-count-measurement/index.md new file mode 100644 index 00000000000..6b7413b9a7a --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-session-count-measurement/index.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SessionCountMeasurement](./index.md) + +# SessionCountMeasurement + +`open class SessionCountMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SessionCountMeasurement.java#L11) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SessionCountMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [countSession](count-session.md) | `open fun countSession(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/-init-.md new file mode 100644 index 00000000000..04255a28489 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SessionDurationMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`SessionDurationMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/flush.md new file mode 100644 index 00000000000..63a9a208f4b --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SessionDurationMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SessionDurationMeasurement.java#L59) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/index.md new file mode 100644 index 00000000000..53abc96954e --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SessionDurationMeasurement](./index.md) + +# SessionDurationMeasurement + +`open class SessionDurationMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SessionDurationMeasurement.java#L14) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SessionDurationMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | +| [recordSessionEnd](record-session-end.md) | `open fun recordSessionEnd(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [recordSessionStart](record-session-start.md) | `open fun recordSessionStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/record-session-end.md b/docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/record-session-end.md new file mode 100644 index 00000000000..6741640c0c3 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/record-session-end.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SessionDurationMeasurement](index.md) / [recordSessionEnd](./record-session-end.md) + +# recordSessionEnd + +`open fun recordSessionEnd(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SessionDurationMeasurement.java#L39) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/record-session-start.md b/docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/record-session-start.md new file mode 100644 index 00000000000..1801c4669fa --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-session-duration-measurement/record-session-start.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SessionDurationMeasurement](index.md) / [recordSessionStart](./record-session-start.md) + +# recordSessionStart + +`open fun recordSessionStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SessionDurationMeasurement.java#L30) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-init-.md new file mode 100644 index 00000000000..a346729a881 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SettingsMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`SettingsMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/contains-key.md b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/contains-key.md new file mode 100644 index 00000000000..b7cc26cff91 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/contains-key.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.measurement](../../index.md) / [SettingsMeasurement](../index.md) / [SettingsProvider](index.md) / [containsKey](./contains-key.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SettingsMeasurement.java#L30) + +Returns true if a settings value is available for the given key. + diff --git a/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/get-value.md b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/get-value.md new file mode 100644 index 00000000000..52f457cd93c --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/get-value.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.measurement](../../index.md) / [SettingsMeasurement](../index.md) / [SettingsProvider](index.md) / [getValue](./get-value.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SettingsMeasurement.java#L35) + +Get the setting value for the given key. + diff --git a/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/index.md b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/index.md new file mode 100644 index 00000000000..00a137d81cd --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/index.md @@ -0,0 +1,22 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.measurement](../../index.md) / [SettingsMeasurement](../index.md) / [SettingsProvider](./index.md) + +# SettingsProvider + +`interface SettingsProvider` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SettingsMeasurement.java#L20) + +A generic interface for implementations that can provide settings values. + +### Functions + +| Name | Summary | +|---|---| +| [containsKey](contains-key.md) | `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.md) | `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.md) | `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.md) | `abstract fun update(configuration: `[`TelemetryConfiguration`](../../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`): `[`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 + +| Name | Summary | +|---|---| +| [SharedPreferenceSettingsProvider](../-shared-preference-settings-provider/index.md) | `open class SharedPreferenceSettingsProvider : `[`SettingsProvider`](./index.md)
Setting provider implementation that reads values from SharedPreferences. | diff --git a/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/release.md b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/release.md new file mode 100644 index 00000000000..e1fae3bd111 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/release.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.measurement](../../index.md) / [SettingsMeasurement](../index.md) / [SettingsProvider](index.md) / [release](./release.md) + +# release + +`abstract fun release(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SettingsMeasurement.java#L40) + +Notify the provider that we finished reading from it and that it can release resources now. + diff --git a/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/update.md b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/update.md new file mode 100644 index 00000000000..3947a174939 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-settings-provider/update.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.measurement](../../index.md) / [SettingsMeasurement](../index.md) / [SettingsProvider](index.md) / [update](./update.md) + +# update + +`abstract fun update(configuration: `[`TelemetryConfiguration`](../../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SettingsMeasurement.java#L25) + +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/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/-init-.md new file mode 100644 index 00000000000..a46e6b8669b --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.measurement](../../index.md) / [SettingsMeasurement](../index.md) / [SharedPreferenceSettingsProvider](index.md) / [<init>](./-init-.md) + +# <init> + +`SharedPreferenceSettingsProvider()` + +Setting provider implementation that reads values from SharedPreferences. + diff --git a/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/contains-key.md b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/contains-key.md new file mode 100644 index 00000000000..cecc09ed2d3 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/contains-key.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.measurement](../../index.md) / [SettingsMeasurement](../index.md) / [SharedPreferenceSettingsProvider](index.md) / [containsKey](./contains-key.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SettingsMeasurement.java#L56) + +Overrides [SettingsProvider.containsKey](../-settings-provider/contains-key.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/get-value.md b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/get-value.md new file mode 100644 index 00000000000..08c0973c4bb --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/get-value.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.measurement](../../index.md) / [SettingsMeasurement](../index.md) / [SharedPreferenceSettingsProvider](index.md) / [getValue](./get-value.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SettingsMeasurement.java#L61) + +Overrides [SettingsProvider.getValue](../-settings-provider/get-value.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/index.md b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/index.md new file mode 100644 index 00000000000..ecf4266e156 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/index.md @@ -0,0 +1,22 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.measurement](../../index.md) / [SettingsMeasurement](../index.md) / [SharedPreferenceSettingsProvider](./index.md) + +# SharedPreferenceSettingsProvider + +`open class SharedPreferenceSettingsProvider : `[`SettingsProvider`](../-settings-provider/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SettingsMeasurement.java#L46) + +Setting provider implementation that reads values from SharedPreferences. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SharedPreferenceSettingsProvider()`
Setting provider implementation that reads values from SharedPreferences. | + +### Functions + +| Name | Summary | +|---|---| +| [containsKey](contains-key.md) | `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.md) | `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.md) | `open fun release(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [update](update.md) | `open fun update(configuration: `[`TelemetryConfiguration`](../../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/release.md b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/release.md new file mode 100644 index 00000000000..f95caec70e1 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/release.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.measurement](../../index.md) / [SettingsMeasurement](../index.md) / [SharedPreferenceSettingsProvider](index.md) / [release](./release.md) + +# release + +`open fun release(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SettingsMeasurement.java#L66) + +Overrides [SettingsProvider.release](../-settings-provider/release.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/update.md b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/update.md new file mode 100644 index 00000000000..2cef1724b83 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/-shared-preference-settings-provider/update.md @@ -0,0 +1,8 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.measurement](../../index.md) / [SettingsMeasurement](../index.md) / [SharedPreferenceSettingsProvider](index.md) / [update](./update.md) + +# update + +`open fun update(configuration: `[`TelemetryConfiguration`](../../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SettingsMeasurement.java#L50) + +Overrides [SettingsProvider.update](../-settings-provider/update.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/flush.md new file mode 100644 index 00000000000..69f668d6bca --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SettingsMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SettingsMeasurement.java#L82) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/index.md new file mode 100644 index 00000000000..435080433aa --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-settings-measurement/index.md @@ -0,0 +1,30 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [SettingsMeasurement](./index.md) + +# SettingsMeasurement + +`open class SettingsMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/SettingsMeasurement.java#L16) + +### Types + +| Name | Summary | +|---|---| +| [SettingsProvider](-settings-provider/index.md) | `interface SettingsProvider`
A generic interface for implementations that can provide settings values. | +| [SharedPreferenceSettingsProvider](-shared-preference-settings-provider/index.md) | `open class SharedPreferenceSettingsProvider : `[`SettingsProvider`](-settings-provider/index.md)
Setting provider implementation that reads values from SharedPreferences. | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `SettingsMeasurement(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-static-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-static-measurement/-init-.md new file mode 100644 index 00000000000..5b29ec83f50 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-static-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [StaticMeasurement](index.md) / [<init>](./-init-.md) + +# <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/org.mozilla.telemetry.measurement/-static-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-static-measurement/flush.md new file mode 100644 index 00000000000..c85339475c1 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-static-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [StaticMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/StaticMeasurement.java#L17) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-static-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-static-measurement/index.md new file mode 100644 index 00000000000..6824ec8ca89 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-static-measurement/index.md @@ -0,0 +1,31 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [StaticMeasurement](./index.md) + +# StaticMeasurement + +`open class StaticMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/StaticMeasurement.java#L7) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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 + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [OperatingSystemMeasurement](../-operating-system-measurement/index.md) | `open class OperatingSystemMeasurement : `[`StaticMeasurement`](./index.md) | +| [OperatingSystemVersionMeasurement](../-operating-system-version-measurement/index.md) | `open class OperatingSystemVersionMeasurement : `[`StaticMeasurement`](./index.md) | +| [VersionMeasurement](../-version-measurement/index.md) | `open class VersionMeasurement : `[`StaticMeasurement`](./index.md) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-telemetry-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-telemetry-measurement/-init-.md new file mode 100644 index 00000000000..882a9760bca --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-telemetry-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [TelemetryMeasurement](index.md) / [<init>](./-init-.md) + +# <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/org.mozilla.telemetry.measurement/-telemetry-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-telemetry-measurement/flush.md new file mode 100644 index 00000000000..aec767b8a63 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-telemetry-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [TelemetryMeasurement](index.md) / [flush](./flush.md) + +# flush + +`abstract fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/TelemetryMeasurement.java#L29) + +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/org.mozilla.telemetry.measurement/-telemetry-measurement/get-field-name.md b/docs/api/org.mozilla.telemetry.measurement/-telemetry-measurement/get-field-name.md new file mode 100644 index 00000000000..c3d1ac37bf2 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-telemetry-measurement/get-field-name.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [TelemetryMeasurement](index.md) / [getFieldName](./get-field-name.md) + +# getFieldName + +`open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/TelemetryMeasurement.java#L14) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-telemetry-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-telemetry-measurement/index.md new file mode 100644 index 00000000000..d2d49a25abf --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-telemetry-measurement/index.md @@ -0,0 +1,46 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [TelemetryMeasurement](./index.md) + +# TelemetryMeasurement + +`abstract class TelemetryMeasurement` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/TelemetryMeasurement.java#L7) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TelemetryMeasurement(fieldName: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `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.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [ArchMeasurement](../-arch-measurement/index.md) | `open class ArchMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [ClientIdMeasurement](../-client-id-measurement/index.md) | `open class ClientIdMeasurement : `[`TelemetryMeasurement`](./index.md)
A unique, randomly generated UUID for this client. | +| [CreatedDateMeasurement](../-created-date-measurement/index.md) | `open class CreatedDateMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [CreatedDateMeasurementNew](../-created-date-measurement-new/index.md) | `open class CreatedDateMeasurementNew : `[`TelemetryMeasurement`](./index.md)
The field 'created' from CreatedDateMeasurement will be deprecated for the `createdDate` field | +| [CreatedTimestampMeasurement](../-created-timestamp-measurement/index.md) | `open class CreatedTimestampMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [CreatedTimestampMeasurementNew](../-created-timestamp-measurement-new/index.md) | `open class CreatedTimestampMeasurementNew : `[`TelemetryMeasurement`](./index.md)
The field 'created' from CreatedTimestampMeasurement will be deprecated for the `createdTimestamp` field | +| [DefaultSearchMeasurement](../-default-search-measurement/index.md) | `open class DefaultSearchMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [DeviceMeasurement](../-device-measurement/index.md) | `open class DeviceMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [EventsMeasurement](../-events-measurement/index.md) | `open class EventsMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [ExperimentsMapMeasurement](../-experiments-map-measurement/index.md) | `class ExperimentsMapMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [ExperimentsMeasurement](../-experiments-measurement/index.md) | `open class ExperimentsMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [FirstRunProfileDateMeasurement](../-first-run-profile-date-measurement/index.md) | `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.md) | `open class LocaleMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [MetricsMeasurement](../-metrics-measurement/index.md) | `open class MetricsMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [PocketIdMeasurement](../-pocket-id-measurement/index.md) | `open class PocketIdMeasurement : `[`TelemetryMeasurement`](./index.md)
A unique, randomly generated UUID for this pocket client for fire-tv instance. This is distinct from the telemetry clientId. The clientId should not be able to be tied to the pocketId in any way. | +| [ProcessStartTimestampMeasurement](../-process-start-timestamp-measurement/index.md) | `open class ProcessStartTimestampMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [SearchesMeasurement](../-searches-measurement/index.md) | `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.md) | `open class SequenceMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [SessionCountMeasurement](../-session-count-measurement/index.md) | `open class SessionCountMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [SessionDurationMeasurement](../-session-duration-measurement/index.md) | `open class SessionDurationMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [SettingsMeasurement](../-settings-measurement/index.md) | `open class SettingsMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [StaticMeasurement](../-static-measurement/index.md) | `open class StaticMeasurement : `[`TelemetryMeasurement`](./index.md) | +| [TimezoneOffsetMeasurement](../-timezone-offset-measurement/index.md) | `open class TimezoneOffsetMeasurement : `[`TelemetryMeasurement`](./index.md) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-timezone-offset-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-timezone-offset-measurement/-init-.md new file mode 100644 index 00000000000..1fa496b6195 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-timezone-offset-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [TimezoneOffsetMeasurement](index.md) / [<init>](./-init-.md) + +# <init> + +`TimezoneOffsetMeasurement()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.measurement/-timezone-offset-measurement/flush.md b/docs/api/org.mozilla.telemetry.measurement/-timezone-offset-measurement/flush.md new file mode 100644 index 00000000000..5bd92a91935 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-timezone-offset-measurement/flush.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [TimezoneOffsetMeasurement](index.md) / [flush](./flush.md) + +# flush + +`open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/TimezoneOffsetMeasurement.java#L21) + +Overrides [TelemetryMeasurement.flush](../-telemetry-measurement/flush.md) + diff --git a/docs/api/org.mozilla.telemetry.measurement/-timezone-offset-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-timezone-offset-measurement/index.md new file mode 100644 index 00000000000..f58ca6e3b81 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-timezone-offset-measurement/index.md @@ -0,0 +1,23 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [TimezoneOffsetMeasurement](./index.md) + +# TimezoneOffsetMeasurement + +`open class TimezoneOffsetMeasurement : `[`TelemetryMeasurement`](../-telemetry-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/TimezoneOffsetMeasurement.java#L13) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TimezoneOffsetMeasurement()` | + +### Functions + +| Name | Summary | +|---|---| +| [flush](flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [getFieldName](../-telemetry-measurement/get-field-name.md) | `open fun getFieldName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/-version-measurement/-init-.md b/docs/api/org.mozilla.telemetry.measurement/-version-measurement/-init-.md new file mode 100644 index 00000000000..10d3b3eda1f --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-version-measurement/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [VersionMeasurement](index.md) / [<init>](./-init-.md) + +# <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/org.mozilla.telemetry.measurement/-version-measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/-version-measurement/index.md new file mode 100644 index 00000000000..2130e25263a --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/-version-measurement/index.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.measurement](../index.md) / [VersionMeasurement](./index.md) + +# VersionMeasurement + +`open class VersionMeasurement : `[`StaticMeasurement`](../-static-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/measurement/VersionMeasurement.java#L7) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `VersionMeasurement(version: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [flush](../-static-measurement/flush.md) | `open fun flush(): `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | diff --git a/docs/api/org.mozilla.telemetry.measurement/index.md b/docs/api/org.mozilla.telemetry.measurement/index.md new file mode 100644 index 00000000000..3f757b15a6f --- /dev/null +++ b/docs/api/org.mozilla.telemetry.measurement/index.md @@ -0,0 +1,35 @@ +[android-components](../index.md) / [org.mozilla.telemetry.measurement](./index.md) + +## Package org.mozilla.telemetry.measurement + +### Types + +| Name | Summary | +|---|---| +| [ArchMeasurement](-arch-measurement/index.md) | `open class ArchMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md) | +| [ClientIdMeasurement](-client-id-measurement/index.md) | `open class ClientIdMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md)
A unique, randomly generated UUID for this client. | +| [CreatedDateMeasurement](-created-date-measurement/index.md) | `open class CreatedDateMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md) | +| [CreatedDateMeasurementNew](-created-date-measurement-new/index.md) | `open class CreatedDateMeasurementNew : `[`TelemetryMeasurement`](-telemetry-measurement/index.md)
The field 'created' from CreatedDateMeasurement will be deprecated for the `createdDate` field | +| [CreatedTimestampMeasurement](-created-timestamp-measurement/index.md) | `open class CreatedTimestampMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md) | +| [CreatedTimestampMeasurementNew](-created-timestamp-measurement-new/index.md) | `open class CreatedTimestampMeasurementNew : `[`TelemetryMeasurement`](-telemetry-measurement/index.md)
The field 'created' from CreatedTimestampMeasurement will be deprecated for the `createdTimestamp` field | +| [DefaultSearchMeasurement](-default-search-measurement/index.md) | `open class DefaultSearchMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md) | +| [DeviceMeasurement](-device-measurement/index.md) | `open class DeviceMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md) | +| [EventsMeasurement](-events-measurement/index.md) | `open class EventsMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md) | +| [ExperimentsMapMeasurement](-experiments-map-measurement/index.md) | `class ExperimentsMapMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md) | +| [ExperimentsMeasurement](-experiments-measurement/index.md) | `open class ExperimentsMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md) | +| [FirstRunProfileDateMeasurement](-first-run-profile-date-measurement/index.md) | `open class FirstRunProfileDateMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/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.md) | `open class LocaleMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md) | +| [MetricsMeasurement](-metrics-measurement/index.md) | `open class MetricsMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md) | +| [OperatingSystemMeasurement](-operating-system-measurement/index.md) | `open class OperatingSystemMeasurement : `[`StaticMeasurement`](-static-measurement/index.md) | +| [OperatingSystemVersionMeasurement](-operating-system-version-measurement/index.md) | `open class OperatingSystemVersionMeasurement : `[`StaticMeasurement`](-static-measurement/index.md) | +| [PocketIdMeasurement](-pocket-id-measurement/index.md) | `open class PocketIdMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md)
A unique, randomly generated UUID for this pocket client for fire-tv instance. This is distinct from the telemetry clientId. The clientId should not be able to be tied to the pocketId in any way. | +| [ProcessStartTimestampMeasurement](-process-start-timestamp-measurement/index.md) | `open class ProcessStartTimestampMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md) | +| [SearchesMeasurement](-searches-measurement/index.md) | `open class SearchesMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/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.md) | `open class SequenceMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md) | +| [SessionCountMeasurement](-session-count-measurement/index.md) | `open class SessionCountMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md) | +| [SessionDurationMeasurement](-session-duration-measurement/index.md) | `open class SessionDurationMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md) | +| [SettingsMeasurement](-settings-measurement/index.md) | `open class SettingsMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md) | +| [StaticMeasurement](-static-measurement/index.md) | `open class StaticMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md) | +| [TelemetryMeasurement](-telemetry-measurement/index.md) | `abstract class TelemetryMeasurement` | +| [TimezoneOffsetMeasurement](-timezone-offset-measurement/index.md) | `open class TimezoneOffsetMeasurement : `[`TelemetryMeasurement`](-telemetry-measurement/index.md) | +| [VersionMeasurement](-version-measurement/index.md) | `open class VersionMeasurement : `[`StaticMeasurement`](-static-measurement/index.md) | diff --git a/docs/api/org.mozilla.telemetry.net/-telemetry-client/-init-.md b/docs/api/org.mozilla.telemetry.net/-telemetry-client/-init-.md new file mode 100644 index 00000000000..900d0d05fa7 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.net/-telemetry-client/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.net](../index.md) / [TelemetryClient](index.md) / [<init>](./-init-.md) + +# <init> + +`TelemetryClient(client: `[`Client`](../../mozilla.components.concept.fetch/-client/index.md)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.net/-telemetry-client/index.md b/docs/api/org.mozilla.telemetry.net/-telemetry-client/index.md new file mode 100644 index 00000000000..a9e79dc6880 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.net/-telemetry-client/index.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.net](../index.md) / [TelemetryClient](./index.md) + +# TelemetryClient + +`class TelemetryClient` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/net/TelemetryClient.kt#L20) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TelemetryClient(client: `[`Client`](../../mozilla.components.concept.fetch/-client/index.md)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [uploadPing](upload-ping.md) | `fun uploadPing(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`, 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/org.mozilla.telemetry.net/-telemetry-client/upload-ping.md b/docs/api/org.mozilla.telemetry.net/-telemetry-client/upload-ping.md new file mode 100644 index 00000000000..63540863670 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.net/-telemetry-client/upload-ping.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.net](../index.md) / [TelemetryClient](index.md) / [uploadPing](./upload-ping.md) + +# uploadPing + +`fun uploadPing(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`, 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/net/TelemetryClient.kt#L26) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.net/index.md b/docs/api/org.mozilla.telemetry.net/index.md new file mode 100644 index 00000000000..28e7c956604 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.net/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [org.mozilla.telemetry.net](./index.md) + +## Package org.mozilla.telemetry.net + +### Types + +| Name | Summary | +|---|---| +| [TelemetryClient](-telemetry-client/index.md) | `class TelemetryClient` | diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/-init-.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/-init-.md new file mode 100644 index 00000000000..e20ba237ddc --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryCorePingBuilder](index.md) / [<init>](./-init-.md) + +# <init> + +`TelemetryCorePingBuilder(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/-t-y-p-e.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/-t-y-p-e.md new file mode 100644 index 00000000000..309cbac70ef --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/-t-y-p-e.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryCorePingBuilder](index.md) / [TYPE](./-t-y-p-e.md) + +# TYPE + +`static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryCorePingBuilder.java#L32) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-default-search-measurement.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-default-search-measurement.md new file mode 100644 index 00000000000..67069363e89 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-default-search-measurement.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryCorePingBuilder](index.md) / [getDefaultSearchMeasurement](./get-default-search-measurement.md) + +# getDefaultSearchMeasurement + +`open fun getDefaultSearchMeasurement(): `[`DefaultSearchMeasurement`](../../org.mozilla.telemetry.measurement/-default-search-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryCorePingBuilder.java#L72) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-experiments-measurement.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-experiments-measurement.md new file mode 100644 index 00000000000..55824febcc4 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-experiments-measurement.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryCorePingBuilder](index.md) / [getExperimentsMeasurement](./get-experiments-measurement.md) + +# getExperimentsMeasurement + +`open fun getExperimentsMeasurement(): `[`ExperimentsMeasurement`](../../org.mozilla.telemetry.measurement/-experiments-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryCorePingBuilder.java#L76) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-searches-measurement.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-searches-measurement.md new file mode 100644 index 00000000000..8849a256e73 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-searches-measurement.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryCorePingBuilder](index.md) / [getSearchesMeasurement](./get-searches-measurement.md) + +# getSearchesMeasurement + +`open fun getSearchesMeasurement(): `[`SearchesMeasurement`](../../org.mozilla.telemetry.measurement/-searches-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryCorePingBuilder.java#L68) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-session-count-measurement.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-session-count-measurement.md new file mode 100644 index 00000000000..c20a20b817e --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-session-count-measurement.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryCorePingBuilder](index.md) / [getSessionCountMeasurement](./get-session-count-measurement.md) + +# getSessionCountMeasurement + +`open fun getSessionCountMeasurement(): `[`SessionCountMeasurement`](../../org.mozilla.telemetry.measurement/-session-count-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryCorePingBuilder.java#L60) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-session-duration-measurement.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-session-duration-measurement.md new file mode 100644 index 00000000000..60a5dd2c822 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/get-session-duration-measurement.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryCorePingBuilder](index.md) / [getSessionDurationMeasurement](./get-session-duration-measurement.md) + +# getSessionDurationMeasurement + +`open fun getSessionDurationMeasurement(): `[`SessionDurationMeasurement`](../../org.mozilla.telemetry.measurement/-session-duration-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryCorePingBuilder.java#L64) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/index.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/index.md new file mode 100644 index 00000000000..e779c38e89f --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-core-ping-builder/index.md @@ -0,0 +1,39 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryCorePingBuilder](./index.md) + +# TelemetryCorePingBuilder + +`open class TelemetryCorePingBuilder : `[`TelemetryPingBuilder`](../-telemetry-ping-builder/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryCorePingBuilder.java#L31) + +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 + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TelemetryCorePingBuilder(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` | + +### Properties + +| Name | Summary | +|---|---| +| [TYPE](-t-y-p-e.md) | `static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [getDefaultSearchMeasurement](get-default-search-measurement.md) | `open fun getDefaultSearchMeasurement(): `[`DefaultSearchMeasurement`](../../org.mozilla.telemetry.measurement/-default-search-measurement/index.md) | +| [getExperimentsMeasurement](get-experiments-measurement.md) | `open fun getExperimentsMeasurement(): `[`ExperimentsMeasurement`](../../org.mozilla.telemetry.measurement/-experiments-measurement/index.md) | +| [getSearchesMeasurement](get-searches-measurement.md) | `open fun getSearchesMeasurement(): `[`SearchesMeasurement`](../../org.mozilla.telemetry.measurement/-searches-measurement/index.md) | +| [getSessionCountMeasurement](get-session-count-measurement.md) | `open fun getSessionCountMeasurement(): `[`SessionCountMeasurement`](../../org.mozilla.telemetry.measurement/-session-count-measurement/index.md) | +| [getSessionDurationMeasurement](get-session-duration-measurement.md) | `open fun getSessionDurationMeasurement(): `[`SessionDurationMeasurement`](../../org.mozilla.telemetry.measurement/-session-duration-measurement/index.md) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [build](../-telemetry-ping-builder/build.md) | `open fun build(): `[`TelemetryPing`](../-telemetry-ping/index.md) | +| [canBuild](../-telemetry-ping-builder/can-build.md) | `open fun canBuild(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [generateDocumentId](../-telemetry-ping-builder/generate-document-id.md) | `open fun generateDocumentId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getConfiguration](../-telemetry-ping-builder/get-configuration.md) | `open fun getConfiguration(): `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md) | +| [getType](../-telemetry-ping-builder/get-type.md) | `open fun getType(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/-init-.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/-init-.md new file mode 100644 index 00000000000..baa5ccb1631 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryEventPingBuilder](index.md) / [<init>](./-init-.md) + +# <init> + +`TelemetryEventPingBuilder(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/-t-y-p-e.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/-t-y-p-e.md new file mode 100644 index 00000000000..8a9085abe1f --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/-t-y-p-e.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryEventPingBuilder](index.md) / [TYPE](./-t-y-p-e.md) + +# TYPE + +`static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryEventPingBuilder.java#L19) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/can-build.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/can-build.md new file mode 100644 index 00000000000..af3a458aaa7 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/can-build.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryEventPingBuilder](index.md) / [canBuild](./can-build.md) + +# canBuild + +`open fun canBuild(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryEventPingBuilder.java#L48) + +Overrides [TelemetryPingBuilder.canBuild](../-telemetry-ping-builder/can-build.md) + diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/get-events-measurement.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/get-events-measurement.md new file mode 100644 index 00000000000..ae901e8d48f --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/get-events-measurement.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryEventPingBuilder](index.md) / [getEventsMeasurement](./get-events-measurement.md) + +# getEventsMeasurement + +`open fun getEventsMeasurement(): `[`EventsMeasurement`](../../org.mozilla.telemetry.measurement/-events-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryEventPingBuilder.java#L39) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/get-experiments-map-measurement.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/get-experiments-map-measurement.md new file mode 100644 index 00000000000..e9433a76ef3 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/get-experiments-map-measurement.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryEventPingBuilder](index.md) / [getExperimentsMapMeasurement](./get-experiments-map-measurement.md) + +# getExperimentsMapMeasurement + +`open fun getExperimentsMapMeasurement(): `[`ExperimentsMapMeasurement`](../../org.mozilla.telemetry.measurement/-experiments-map-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryEventPingBuilder.java#L43) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/index.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/index.md new file mode 100644 index 00000000000..76453c5d4fa --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-event-ping-builder/index.md @@ -0,0 +1,36 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryEventPingBuilder](./index.md) + +# TelemetryEventPingBuilder + +`open class TelemetryEventPingBuilder : `[`TelemetryPingBuilder`](../-telemetry-ping-builder/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryEventPingBuilder.java#L18) + +A telemetry ping builder for pings of type "focus-event". + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TelemetryEventPingBuilder(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` | + +### Properties + +| Name | Summary | +|---|---| +| [TYPE](-t-y-p-e.md) | `static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [canBuild](can-build.md) | `open fun canBuild(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [getEventsMeasurement](get-events-measurement.md) | `open fun getEventsMeasurement(): `[`EventsMeasurement`](../../org.mozilla.telemetry.measurement/-events-measurement/index.md) | +| [getExperimentsMapMeasurement](get-experiments-map-measurement.md) | `open fun getExperimentsMapMeasurement(): `[`ExperimentsMapMeasurement`](../../org.mozilla.telemetry.measurement/-experiments-map-measurement/index.md) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [build](../-telemetry-ping-builder/build.md) | `open fun build(): `[`TelemetryPing`](../-telemetry-ping/index.md) | +| [generateDocumentId](../-telemetry-ping-builder/generate-document-id.md) | `open fun generateDocumentId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getConfiguration](../-telemetry-ping-builder/get-configuration.md) | `open fun getConfiguration(): `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md) | +| [getType](../-telemetry-ping-builder/get-type.md) | `open fun getType(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/-init-.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/-init-.md new file mode 100644 index 00000000000..c12bda745a7 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryMobileEventPingBuilder](index.md) / [<init>](./-init-.md) + +# <init> + +`TelemetryMobileEventPingBuilder(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/-t-y-p-e.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/-t-y-p-e.md new file mode 100644 index 00000000000..b118da7ee91 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/-t-y-p-e.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryMobileEventPingBuilder](index.md) / [TYPE](./-t-y-p-e.md) + +# TYPE + +`static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryMobileEventPingBuilder.java#L17) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/can-build.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/can-build.md new file mode 100644 index 00000000000..d3b0b231807 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/can-build.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryMobileEventPingBuilder](index.md) / [canBuild](./can-build.md) + +# canBuild + +`open fun canBuild(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryMobileEventPingBuilder.java#L47) + +Overrides [TelemetryPingBuilder.canBuild](../-telemetry-ping-builder/can-build.md) + diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/get-events-measurement.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/get-events-measurement.md new file mode 100644 index 00000000000..5f61b92fb22 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/get-events-measurement.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryMobileEventPingBuilder](index.md) / [getEventsMeasurement](./get-events-measurement.md) + +# getEventsMeasurement + +`open fun getEventsMeasurement(): `[`EventsMeasurement`](../../org.mozilla.telemetry.measurement/-events-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryMobileEventPingBuilder.java#L38) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/get-experiments-map-measurement.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/get-experiments-map-measurement.md new file mode 100644 index 00000000000..39f8625e86d --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/get-experiments-map-measurement.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryMobileEventPingBuilder](index.md) / [getExperimentsMapMeasurement](./get-experiments-map-measurement.md) + +# getExperimentsMapMeasurement + +`open fun getExperimentsMapMeasurement(): `[`ExperimentsMapMeasurement`](../../org.mozilla.telemetry.measurement/-experiments-map-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryMobileEventPingBuilder.java#L42) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/index.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/index.md new file mode 100644 index 00000000000..29421ad606c --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-event-ping-builder/index.md @@ -0,0 +1,36 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryMobileEventPingBuilder](./index.md) + +# TelemetryMobileEventPingBuilder + +`open class TelemetryMobileEventPingBuilder : `[`TelemetryPingBuilder`](../-telemetry-ping-builder/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryMobileEventPingBuilder.java#L16) + +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 + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TelemetryMobileEventPingBuilder(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` | + +### Properties + +| Name | Summary | +|---|---| +| [TYPE](-t-y-p-e.md) | `static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [canBuild](can-build.md) | `open fun canBuild(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [getEventsMeasurement](get-events-measurement.md) | `open fun getEventsMeasurement(): `[`EventsMeasurement`](../../org.mozilla.telemetry.measurement/-events-measurement/index.md) | +| [getExperimentsMapMeasurement](get-experiments-map-measurement.md) | `open fun getExperimentsMapMeasurement(): `[`ExperimentsMapMeasurement`](../../org.mozilla.telemetry.measurement/-experiments-map-measurement/index.md) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [build](../-telemetry-ping-builder/build.md) | `open fun build(): `[`TelemetryPing`](../-telemetry-ping/index.md) | +| [generateDocumentId](../-telemetry-ping-builder/generate-document-id.md) | `open fun generateDocumentId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getConfiguration](../-telemetry-ping-builder/get-configuration.md) | `open fun getConfiguration(): `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md) | +| [getType](../-telemetry-ping-builder/get-type.md) | `open fun getType(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/-init-.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/-init-.md new file mode 100644 index 00000000000..3181baefe73 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryMobileMetricsPingBuilder](index.md) / [<init>](./-init-.md) + +# <init> + +`TelemetryMobileMetricsPingBuilder(snapshots: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`, configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/-t-y-p-e.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/-t-y-p-e.md new file mode 100644 index 00000000000..c7f99faa54c --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/-t-y-p-e.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryMobileMetricsPingBuilder](index.md) / [TYPE](./-t-y-p-e.md) + +# TYPE + +`static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryMobileMetricsPingBuilder.java#L29) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/index.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/index.md new file mode 100644 index 00000000000..8fba3ab0214 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-mobile-metrics-ping-builder/index.md @@ -0,0 +1,29 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryMobileMetricsPingBuilder](./index.md) + +# TelemetryMobileMetricsPingBuilder + +`open class TelemetryMobileMetricsPingBuilder : `[`TelemetryPingBuilder`](../-telemetry-ping-builder/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryMobileMetricsPingBuilder.java#L28) + +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 + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TelemetryMobileMetricsPingBuilder(snapshots: `[`JSONObject`](https://developer.android.com/reference/org/json/JSONObject.html)`, configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` | + +### Properties + +| Name | Summary | +|---|---| +| [TYPE](-t-y-p-e.md) | `static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [build](../-telemetry-ping-builder/build.md) | `open fun build(): `[`TelemetryPing`](../-telemetry-ping/index.md) | +| [canBuild](../-telemetry-ping-builder/can-build.md) | `open fun canBuild(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [generateDocumentId](../-telemetry-ping-builder/generate-document-id.md) | `open fun generateDocumentId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getConfiguration](../-telemetry-ping-builder/get-configuration.md) | `open fun getConfiguration(): `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md) | +| [getType](../-telemetry-ping-builder/get-type.md) | `open fun getType(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/-init-.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/-init-.md new file mode 100644 index 00000000000..f6410bbfd83 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryPingBuilder](index.md) / [<init>](./-init-.md) + +# <init> + +`TelemetryPingBuilder(@NonNull configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`, @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/org.mozilla.telemetry.ping/-telemetry-ping-builder/build.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/build.md new file mode 100644 index 00000000000..5728113403f --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/build.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryPingBuilder](index.md) / [build](./build.md) + +# build + +`open fun build(): `[`TelemetryPing`](../-telemetry-ping/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryPingBuilder.java#L62) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/can-build.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/can-build.md new file mode 100644 index 00000000000..40806c5deb3 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/can-build.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryPingBuilder](index.md) / [canBuild](./can-build.md) + +# canBuild + +`open fun canBuild(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryPingBuilder.java#L58) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/generate-document-id.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/generate-document-id.md new file mode 100644 index 00000000000..b373a9e4a82 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/generate-document-id.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryPingBuilder](index.md) / [generateDocumentId](./generate-document-id.md) + +# generateDocumentId + +`open fun generateDocumentId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryPingBuilder.java#L96) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/get-configuration.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/get-configuration.md new file mode 100644 index 00000000000..8274a920253 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/get-configuration.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryPingBuilder](index.md) / [getConfiguration](./get-configuration.md) + +# getConfiguration + +`open fun getConfiguration(): `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryPingBuilder.java#L40) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/get-type.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/get-type.md new file mode 100644 index 00000000000..e5f9c0d9c4d --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/get-type.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryPingBuilder](index.md) / [getType](./get-type.md) + +# getType + +`@NonNull open fun getType(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryPingBuilder.java#L50) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/index.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/index.md new file mode 100644 index 00000000000..eec55f86ff2 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping-builder/index.md @@ -0,0 +1,31 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryPingBuilder](./index.md) + +# TelemetryPingBuilder + +`abstract class TelemetryPingBuilder` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryPingBuilder.java#L22) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TelemetryPingBuilder(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`, 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 + +| Name | Summary | +|---|---| +| [build](build.md) | `open fun build(): `[`TelemetryPing`](../-telemetry-ping/index.md) | +| [canBuild](can-build.md) | `open fun canBuild(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [generateDocumentId](generate-document-id.md) | `open fun generateDocumentId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getConfiguration](get-configuration.md) | `open fun getConfiguration(): `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md) | +| [getType](get-type.md) | `open fun getType(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [TelemetryCorePingBuilder](../-telemetry-core-ping-builder/index.md) | `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.md) | `open class TelemetryEventPingBuilder : `[`TelemetryPingBuilder`](./index.md)
A telemetry ping builder for pings of type "focus-event". | +| [TelemetryMobileEventPingBuilder](../-telemetry-mobile-event-ping-builder/index.md) | `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.md) | `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 | +| [TelemetryPocketEventPingBuilder](../-telemetry-pocket-event-ping-builder/index.md) | `open class TelemetryPocketEventPingBuilder : `[`TelemetryPingBuilder`](./index.md)
A telemetry ping builder for events of type "fire-tv-events". See the schema for more details: https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/dc458113a7a523e60a9ba50e1174a3b1e0cfdc24/schemas/pocket/fire-tv-events/fire-tv-events.1.schema.json | diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-ping/get-document-id.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping/get-document-id.md new file mode 100644 index 00000000000..f2ae5fd5e4c --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping/get-document-id.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryPing](index.md) / [getDocumentId](./get-document-id.md) + +# getDocumentId + +`open fun getDocumentId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryPing.java#L26) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-ping/get-measurement-results.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping/get-measurement-results.md new file mode 100644 index 00000000000..1fcfc771010 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping/get-measurement-results.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryPing](index.md) / [getMeasurementResults](./get-measurement-results.md) + +# 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)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryPing.java#L34) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-ping/get-type.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping/get-type.md new file mode 100644 index 00000000000..6ee85f69a2e --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping/get-type.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryPing](index.md) / [getType](./get-type.md) + +# getType + +`open fun getType(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryPing.java#L22) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-ping/get-upload-path.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping/get-upload-path.md new file mode 100644 index 00000000000..ce0f2996dc9 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping/get-upload-path.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryPing](index.md) / [getUploadPath](./get-upload-path.md) + +# getUploadPath + +`open fun getUploadPath(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryPing.java#L30) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-ping/index.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping/index.md new file mode 100644 index 00000000000..c4a8a8a82c8 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-ping/index.md @@ -0,0 +1,14 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryPing](./index.md) + +# TelemetryPing + +`open class TelemetryPing` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryPing.java#L9) + +### Functions + +| Name | Summary | +|---|---| +| [getDocumentId](get-document-id.md) | `open fun getDocumentId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getMeasurementResults](get-measurement-results.md) | `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.md) | `open fun getType(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getUploadPath](get-upload-path.md) | `open fun getUploadPath(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-pocket-event-ping-builder/-init-.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-pocket-event-ping-builder/-init-.md new file mode 100644 index 00000000000..9aa528ef3b6 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-pocket-event-ping-builder/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryPocketEventPingBuilder](index.md) / [<init>](./-init-.md) + +# <init> + +`TelemetryPocketEventPingBuilder(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-pocket-event-ping-builder/-t-y-p-e.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-pocket-event-ping-builder/-t-y-p-e.md new file mode 100644 index 00000000000..ed5fcc2a1e9 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-pocket-event-ping-builder/-t-y-p-e.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryPocketEventPingBuilder](index.md) / [TYPE](./-t-y-p-e.md) + +# TYPE + +`static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryPocketEventPingBuilder.java#L26) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-pocket-event-ping-builder/get-events-measurement.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-pocket-event-ping-builder/get-events-measurement.md new file mode 100644 index 00000000000..10f0bc8a1ba --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-pocket-event-ping-builder/get-events-measurement.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryPocketEventPingBuilder](index.md) / [getEventsMeasurement](./get-events-measurement.md) + +# getEventsMeasurement + +`open fun getEventsMeasurement(): `[`EventsMeasurement`](../../org.mozilla.telemetry.measurement/-events-measurement/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryPocketEventPingBuilder.java#L51) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.ping/-telemetry-pocket-event-ping-builder/index.md b/docs/api/org.mozilla.telemetry.ping/-telemetry-pocket-event-ping-builder/index.md new file mode 100644 index 00000000000..795b710db7a --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/-telemetry-pocket-event-ping-builder/index.md @@ -0,0 +1,35 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.ping](../index.md) / [TelemetryPocketEventPingBuilder](./index.md) + +# TelemetryPocketEventPingBuilder + +`open class TelemetryPocketEventPingBuilder : `[`TelemetryPingBuilder`](../-telemetry-ping-builder/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/ping/TelemetryPocketEventPingBuilder.java#L25) + +A telemetry ping builder for events of type "fire-tv-events". See the schema for more details: https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/dc458113a7a523e60a9ba50e1174a3b1e0cfdc24/schemas/pocket/fire-tv-events/fire-tv-events.1.schema.json + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TelemetryPocketEventPingBuilder(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`)` | + +### Properties + +| Name | Summary | +|---|---| +| [TYPE](-t-y-p-e.md) | `static val TYPE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Functions + +| Name | Summary | +|---|---| +| [getEventsMeasurement](get-events-measurement.md) | `open fun getEventsMeasurement(): `[`EventsMeasurement`](../../org.mozilla.telemetry.measurement/-events-measurement/index.md) | + +### Inherited Functions + +| Name | Summary | +|---|---| +| [build](../-telemetry-ping-builder/build.md) | `open fun build(): `[`TelemetryPing`](../-telemetry-ping/index.md) | +| [canBuild](../-telemetry-ping-builder/can-build.md) | `open fun canBuild(): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [generateDocumentId](../-telemetry-ping-builder/generate-document-id.md) | `open fun generateDocumentId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getConfiguration](../-telemetry-ping-builder/get-configuration.md) | `open fun getConfiguration(): `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md) | +| [getType](../-telemetry-ping-builder/get-type.md) | `open fun getType(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.ping/index.md b/docs/api/org.mozilla.telemetry.ping/index.md new file mode 100644 index 00000000000..274cb878fc9 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.ping/index.md @@ -0,0 +1,15 @@ +[android-components](../index.md) / [org.mozilla.telemetry.ping](./index.md) + +## Package org.mozilla.telemetry.ping + +### Types + +| Name | Summary | +|---|---| +| [TelemetryCorePingBuilder](-telemetry-core-ping-builder/index.md) | `open class TelemetryCorePingBuilder : `[`TelemetryPingBuilder`](-telemetry-ping-builder/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.md) | `open class TelemetryEventPingBuilder : `[`TelemetryPingBuilder`](-telemetry-ping-builder/index.md)
A telemetry ping builder for pings of type "focus-event". | +| [TelemetryMobileEventPingBuilder](-telemetry-mobile-event-ping-builder/index.md) | `open class TelemetryMobileEventPingBuilder : `[`TelemetryPingBuilder`](-telemetry-ping-builder/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.md) | `open class TelemetryMobileMetricsPingBuilder : `[`TelemetryPingBuilder`](-telemetry-ping-builder/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 | +| [TelemetryPing](-telemetry-ping/index.md) | `open class TelemetryPing` | +| [TelemetryPingBuilder](-telemetry-ping-builder/index.md) | `abstract class TelemetryPingBuilder` | +| [TelemetryPocketEventPingBuilder](-telemetry-pocket-event-ping-builder/index.md) | `open class TelemetryPocketEventPingBuilder : `[`TelemetryPingBuilder`](-telemetry-ping-builder/index.md)
A telemetry ping builder for events of type "fire-tv-events". See the schema for more details: https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/dc458113a7a523e60a9ba50e1174a3b1e0cfdc24/schemas/pocket/fire-tv-events/fire-tv-events.1.schema.json | diff --git a/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/-init-.md b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/-init-.md new file mode 100644 index 00000000000..a6e91f5b605 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/-init-.md @@ -0,0 +1,6 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.schedule.jobscheduler](../index.md) / [JobSchedulerTelemetryScheduler](index.md) / [<init>](./-init-.md) + +# <init> + +`JobSchedulerTelemetryScheduler()` +`JobSchedulerTelemetryScheduler(jobId: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/index.md b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/index.md new file mode 100644 index 00000000000..17ef8ec9eed --- /dev/null +++ b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/index.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.schedule.jobscheduler](../index.md) / [JobSchedulerTelemetryScheduler](./index.md) + +# JobSchedulerTelemetryScheduler + +`open class JobSchedulerTelemetryScheduler : `[`TelemetryScheduler`](../../org.mozilla.telemetry.schedule/-telemetry-scheduler/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/schedule/jobscheduler/JobSchedulerTelemetryScheduler.java#L18) + +TelemetryScheduler implementation that uses Android's JobScheduler API to schedule ping uploads. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `JobSchedulerTelemetryScheduler()`
`JobSchedulerTelemetryScheduler(jobId: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [scheduleUpload](schedule-upload.md) | `open fun scheduleUpload(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/schedule-upload.md b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/schedule-upload.md new file mode 100644 index 00000000000..0e022bcb8b3 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/schedule-upload.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.schedule.jobscheduler](../index.md) / [JobSchedulerTelemetryScheduler](index.md) / [scheduleUpload](./schedule-upload.md) + +# scheduleUpload + +`open fun scheduleUpload(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/schedule/jobscheduler/JobSchedulerTelemetryScheduler.java#L32) + +Overrides [TelemetryScheduler.scheduleUpload](../../org.mozilla.telemetry.schedule/-telemetry-scheduler/schedule-upload.md) + diff --git a/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/-init-.md b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/-init-.md new file mode 100644 index 00000000000..56e711edae2 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.schedule.jobscheduler](../index.md) / [TelemetryJobService](index.md) / [<init>](./-init-.md) + +# <init> + +`TelemetryJobService()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/index.md b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/index.md new file mode 100644 index 00000000000..9bf6e85526a --- /dev/null +++ b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/index.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.schedule.jobscheduler](../index.md) / [TelemetryJobService](./index.md) + +# TelemetryJobService + +`open class TelemetryJobService : `[`JobService`](https://developer.android.com/reference/android/app/job/JobService.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/schedule/jobscheduler/TelemetryJobService.java#L26) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `TelemetryJobService()` | + +### Functions + +| Name | Summary | +|---|---| +| [onStartJob](on-start-job.md) | `open fun onStartJob(params: `[`JobParameters`](https://developer.android.com/reference/android/app/job/JobParameters.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onStopJob](on-stop-job.md) | `open fun onStopJob(params: `[`JobParameters`](https://developer.android.com/reference/android/app/job/JobParameters.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [uploadPingsInBackground](upload-pings-in-background.md) | `open fun uploadPingsInBackground(task: `[`AsyncTask`](https://developer.android.com/reference/android/os/AsyncTask.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)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>, parameters: `[`JobParameters`](https://developer.android.com/reference/android/app/job/JobParameters.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/on-start-job.md b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/on-start-job.md new file mode 100644 index 00000000000..93512b8bc30 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/on-start-job.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.schedule.jobscheduler](../index.md) / [TelemetryJobService](index.md) / [onStartJob](./on-start-job.md) + +# onStartJob + +`open fun onStartJob(params: `[`JobParameters`](https://developer.android.com/reference/android/app/job/JobParameters.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/schedule/jobscheduler/TelemetryJobService.java#L34) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/on-stop-job.md b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/on-stop-job.md new file mode 100644 index 00000000000..2e8dadfd42a --- /dev/null +++ b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/on-stop-job.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.schedule.jobscheduler](../index.md) / [TelemetryJobService](index.md) / [onStopJob](./on-stop-job.md) + +# onStopJob + +`open fun onStopJob(params: `[`JobParameters`](https://developer.android.com/reference/android/app/job/JobParameters.html)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/schedule/jobscheduler/TelemetryJobService.java#L41) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/upload-pings-in-background.md b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/upload-pings-in-background.md new file mode 100644 index 00000000000..fd6082d34ee --- /dev/null +++ b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/-telemetry-job-service/upload-pings-in-background.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.schedule.jobscheduler](../index.md) / [TelemetryJobService](index.md) / [uploadPingsInBackground](./upload-pings-in-background.md) + +# uploadPingsInBackground + +`open fun uploadPingsInBackground(task: `[`AsyncTask`](https://developer.android.com/reference/android/os/AsyncTask.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)`, `[`Any`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)`>, parameters: `[`JobParameters`](https://developer.android.com/reference/android/app/job/JobParameters.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/schedule/jobscheduler/TelemetryJobService.java#L58) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.schedule.jobscheduler/index.md b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/index.md new file mode 100644 index 00000000000..5b442971eb0 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.schedule.jobscheduler/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [org.mozilla.telemetry.schedule.jobscheduler](./index.md) + +## Package org.mozilla.telemetry.schedule.jobscheduler + +### Types + +| Name | Summary | +|---|---| +| [JobSchedulerTelemetryScheduler](-job-scheduler-telemetry-scheduler/index.md) | `open class JobSchedulerTelemetryScheduler : `[`TelemetryScheduler`](../org.mozilla.telemetry.schedule/-telemetry-scheduler/index.md)
TelemetryScheduler implementation that uses Android's JobScheduler API to schedule ping uploads. | +| [TelemetryJobService](-telemetry-job-service/index.md) | `open class TelemetryJobService : `[`JobService`](https://developer.android.com/reference/android/app/job/JobService.html) | diff --git a/docs/api/org.mozilla.telemetry.schedule/-telemetry-scheduler/index.md b/docs/api/org.mozilla.telemetry.schedule/-telemetry-scheduler/index.md new file mode 100644 index 00000000000..694459ab313 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.schedule/-telemetry-scheduler/index.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.schedule](../index.md) / [TelemetryScheduler](./index.md) + +# TelemetryScheduler + +`interface TelemetryScheduler` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/schedule/TelemetryScheduler.java#L9) + +### Functions + +| Name | Summary | +|---|---| +| [scheduleUpload](schedule-upload.md) | `abstract fun scheduleUpload(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [JobSchedulerTelemetryScheduler](../../org.mozilla.telemetry.schedule.jobscheduler/-job-scheduler-telemetry-scheduler/index.md) | `open class JobSchedulerTelemetryScheduler : `[`TelemetryScheduler`](./index.md)
TelemetryScheduler implementation that uses Android's JobScheduler API to schedule ping uploads. | diff --git a/docs/api/org.mozilla.telemetry.schedule/-telemetry-scheduler/schedule-upload.md b/docs/api/org.mozilla.telemetry.schedule/-telemetry-scheduler/schedule-upload.md new file mode 100644 index 00000000000..6a4da2f113f --- /dev/null +++ b/docs/api/org.mozilla.telemetry.schedule/-telemetry-scheduler/schedule-upload.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.schedule](../index.md) / [TelemetryScheduler](index.md) / [scheduleUpload](./schedule-upload.md) + +# scheduleUpload + +`abstract fun scheduleUpload(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/schedule/TelemetryScheduler.java#L10) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.schedule/index.md b/docs/api/org.mozilla.telemetry.schedule/index.md new file mode 100644 index 00000000000..062f2be911c --- /dev/null +++ b/docs/api/org.mozilla.telemetry.schedule/index.md @@ -0,0 +1,9 @@ +[android-components](../index.md) / [org.mozilla.telemetry.schedule](./index.md) + +## Package org.mozilla.telemetry.schedule + +### Types + +| Name | Summary | +|---|---| +| [TelemetryScheduler](-telemetry-scheduler/index.md) | `interface TelemetryScheduler` | diff --git a/docs/api/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/-init-.md b/docs/api/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/-init-.md new file mode 100644 index 00000000000..edcb7756c00 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.serialize](../index.md) / [JSONPingSerializer](index.md) / [<init>](./-init-.md) + +# <init> + +`JSONPingSerializer()` + +TelemetryPingSerializer that uses the org.json library provided by the Android system. + diff --git a/docs/api/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/index.md b/docs/api/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/index.md new file mode 100644 index 00000000000..22ba96ae980 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/index.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.serialize](../index.md) / [JSONPingSerializer](./index.md) + +# JSONPingSerializer + +`open class JSONPingSerializer : `[`TelemetryPingSerializer`](../-telemetry-ping-serializer/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/serialize/JSONPingSerializer.java#L16) + +TelemetryPingSerializer that uses the org.json library provided by the Android system. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `JSONPingSerializer()`
TelemetryPingSerializer that uses the org.json library provided by the Android system. | + +### Functions + +| Name | Summary | +|---|---| +| [serialize](serialize.md) | `open fun serialize(ping: `[`TelemetryPing`](../../org.mozilla.telemetry.ping/-telemetry-ping/index.md)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/serialize.md b/docs/api/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/serialize.md new file mode 100644 index 00000000000..05da4588b15 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.serialize/-j-s-o-n-ping-serializer/serialize.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.serialize](../index.md) / [JSONPingSerializer](index.md) / [serialize](./serialize.md) + +# serialize + +`open fun serialize(ping: `[`TelemetryPing`](../../org.mozilla.telemetry.ping/-telemetry-ping/index.md)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/serialize/JSONPingSerializer.java#L18) + +Overrides [TelemetryPingSerializer.serialize](../-telemetry-ping-serializer/serialize.md) + diff --git a/docs/api/org.mozilla.telemetry.serialize/-telemetry-ping-serializer/index.md b/docs/api/org.mozilla.telemetry.serialize/-telemetry-ping-serializer/index.md new file mode 100644 index 00000000000..04079e33f21 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.serialize/-telemetry-ping-serializer/index.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.serialize](../index.md) / [TelemetryPingSerializer](./index.md) + +# TelemetryPingSerializer + +`interface TelemetryPingSerializer` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/serialize/TelemetryPingSerializer.java#L9) + +### Functions + +| Name | Summary | +|---|---| +| [serialize](serialize.md) | `abstract fun serialize(ping: `[`TelemetryPing`](../../org.mozilla.telemetry.ping/-telemetry-ping/index.md)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [JSONPingSerializer](../-j-s-o-n-ping-serializer/index.md) | `open class JSONPingSerializer : `[`TelemetryPingSerializer`](./index.md)
TelemetryPingSerializer that uses the org.json library provided by the Android system. | diff --git a/docs/api/org.mozilla.telemetry.serialize/-telemetry-ping-serializer/serialize.md b/docs/api/org.mozilla.telemetry.serialize/-telemetry-ping-serializer/serialize.md new file mode 100644 index 00000000000..73a68bc2f44 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.serialize/-telemetry-ping-serializer/serialize.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.serialize](../index.md) / [TelemetryPingSerializer](index.md) / [serialize](./serialize.md) + +# serialize + +`abstract fun serialize(ping: `[`TelemetryPing`](../../org.mozilla.telemetry.ping/-telemetry-ping/index.md)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/serialize/TelemetryPingSerializer.java#L10) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.serialize/index.md b/docs/api/org.mozilla.telemetry.serialize/index.md new file mode 100644 index 00000000000..9968e5feb0d --- /dev/null +++ b/docs/api/org.mozilla.telemetry.serialize/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [org.mozilla.telemetry.serialize](./index.md) + +## Package org.mozilla.telemetry.serialize + +### Types + +| Name | Summary | +|---|---| +| [JSONPingSerializer](-j-s-o-n-ping-serializer/index.md) | `open class JSONPingSerializer : `[`TelemetryPingSerializer`](-telemetry-ping-serializer/index.md)
TelemetryPingSerializer that uses the org.json library provided by the Android system. | +| [TelemetryPingSerializer](-telemetry-ping-serializer/index.md) | `interface TelemetryPingSerializer` | diff --git a/docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/-init-.md b/docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/-init-.md new file mode 100644 index 00000000000..e571337f4e1 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.storage](../index.md) / [FileTelemetryStorage](index.md) / [<init>](./-init-.md) + +# <init> + +`FileTelemetryStorage(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`, serializer: `[`TelemetryPingSerializer`](../../org.mozilla.telemetry.serialize/-telemetry-ping-serializer/index.md)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/count-stored-pings.md b/docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/count-stored-pings.md new file mode 100644 index 00000000000..95dbba9e7f2 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/count-stored-pings.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.storage](../index.md) / [FileTelemetryStorage](index.md) / [countStoredPings](./count-stored-pings.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/storage/FileTelemetryStorage.java#L163) + +Overrides [TelemetryStorage.countStoredPings](../-telemetry-storage/count-stored-pings.md) + diff --git a/docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/index.md b/docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/index.md new file mode 100644 index 00000000000..5491e3fc6d0 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/index.md @@ -0,0 +1,21 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.storage](../index.md) / [FileTelemetryStorage](./index.md) + +# FileTelemetryStorage + +`open class FileTelemetryStorage : `[`TelemetryStorage`](../-telemetry-storage/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/storage/FileTelemetryStorage.java#L37) + +TelemetryStorage implementation that stores pings as files on disk. + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FileTelemetryStorage(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`, serializer: `[`TelemetryPingSerializer`](../../org.mozilla.telemetry.serialize/-telemetry-ping-serializer/index.md)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [countStoredPings](count-stored-pings.md) | `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.md) | `open fun process(pingType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, callback: `[`TelemetryStorageCallback`](../-telemetry-storage/-telemetry-storage-callback/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [store](store.md) | `open fun store(ping: `[`TelemetryPing`](../../org.mozilla.telemetry.ping/-telemetry-ping/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/process.md b/docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/process.md new file mode 100644 index 00000000000..c591c9451dc --- /dev/null +++ b/docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/process.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.storage](../index.md) / [FileTelemetryStorage](index.md) / [process](./process.md) + +# 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.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/storage/FileTelemetryStorage.java#L64) + +Overrides [TelemetryStorage.process](../-telemetry-storage/process.md) + diff --git a/docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/store.md b/docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/store.md new file mode 100644 index 00000000000..3f9f979e80e --- /dev/null +++ b/docs/api/org.mozilla.telemetry.storage/-file-telemetry-storage/store.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.storage](../index.md) / [FileTelemetryStorage](index.md) / [store](./store.md) + +# store + +`open fun store(ping: `[`TelemetryPing`](../../org.mozilla.telemetry.ping/-telemetry-ping/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/storage/FileTelemetryStorage.java#L58) + +Overrides [TelemetryStorage.store](../-telemetry-storage/store.md) + diff --git a/docs/api/org.mozilla.telemetry.storage/-telemetry-storage/-telemetry-storage-callback/index.md b/docs/api/org.mozilla.telemetry.storage/-telemetry-storage/-telemetry-storage-callback/index.md new file mode 100644 index 00000000000..d3a4291cd82 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.storage/-telemetry-storage/-telemetry-storage-callback/index.md @@ -0,0 +1,11 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.storage](../../index.md) / [TelemetryStorage](../index.md) / [TelemetryStorageCallback](./index.md) + +# TelemetryStorageCallback + +`interface TelemetryStorageCallback` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/storage/TelemetryStorage.java#L10) + +### Functions + +| Name | Summary | +|---|---| +| [onTelemetryPingLoaded](on-telemetry-ping-loaded.md) | `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/org.mozilla.telemetry.storage/-telemetry-storage/-telemetry-storage-callback/on-telemetry-ping-loaded.md b/docs/api/org.mozilla.telemetry.storage/-telemetry-storage/-telemetry-storage-callback/on-telemetry-ping-loaded.md new file mode 100644 index 00000000000..b0640ea09ca --- /dev/null +++ b/docs/api/org.mozilla.telemetry.storage/-telemetry-storage/-telemetry-storage-callback/on-telemetry-ping-loaded.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.storage](../../index.md) / [TelemetryStorage](../index.md) / [TelemetryStorageCallback](index.md) / [onTelemetryPingLoaded](./on-telemetry-ping-loaded.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/storage/TelemetryStorage.java#L11) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.storage/-telemetry-storage/count-stored-pings.md b/docs/api/org.mozilla.telemetry.storage/-telemetry-storage/count-stored-pings.md new file mode 100644 index 00000000000..4cdbf309109 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.storage/-telemetry-storage/count-stored-pings.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.storage](../index.md) / [TelemetryStorage](index.md) / [countStoredPings](./count-stored-pings.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/storage/TelemetryStorage.java#L18) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.storage/-telemetry-storage/index.md b/docs/api/org.mozilla.telemetry.storage/-telemetry-storage/index.md new file mode 100644 index 00000000000..9122535ed89 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.storage/-telemetry-storage/index.md @@ -0,0 +1,25 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.storage](../index.md) / [TelemetryStorage](./index.md) + +# TelemetryStorage + +`interface TelemetryStorage` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/storage/TelemetryStorage.java#L9) + +### Types + +| Name | Summary | +|---|---| +| [TelemetryStorageCallback](-telemetry-storage-callback/index.md) | `interface TelemetryStorageCallback` | + +### Functions + +| Name | Summary | +|---|---| +| [countStoredPings](count-stored-pings.md) | `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.md) | `abstract fun process(pingType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, callback: `[`TelemetryStorageCallback`](-telemetry-storage-callback/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [store](store.md) | `abstract fun store(ping: `[`TelemetryPing`](../../org.mozilla.telemetry.ping/-telemetry-ping/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | + +### Inheritors + +| Name | Summary | +|---|---| +| [FileTelemetryStorage](../-file-telemetry-storage/index.md) | `open class FileTelemetryStorage : `[`TelemetryStorage`](./index.md)
TelemetryStorage implementation that stores pings as files on disk. | diff --git a/docs/api/org.mozilla.telemetry.storage/-telemetry-storage/process.md b/docs/api/org.mozilla.telemetry.storage/-telemetry-storage/process.md new file mode 100644 index 00000000000..961833c047f --- /dev/null +++ b/docs/api/org.mozilla.telemetry.storage/-telemetry-storage/process.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.storage](../index.md) / [TelemetryStorage](index.md) / [process](./process.md) + +# process + +`abstract fun process(pingType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, callback: `[`TelemetryStorageCallback`](-telemetry-storage-callback/index.md)`): `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/storage/TelemetryStorage.java#L16) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.storage/-telemetry-storage/store.md b/docs/api/org.mozilla.telemetry.storage/-telemetry-storage/store.md new file mode 100644 index 00000000000..2c2f46cedba --- /dev/null +++ b/docs/api/org.mozilla.telemetry.storage/-telemetry-storage/store.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.storage](../index.md) / [TelemetryStorage](index.md) / [store](./store.md) + +# store + +`abstract fun store(ping: `[`TelemetryPing`](../../org.mozilla.telemetry.ping/-telemetry-ping/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/storage/TelemetryStorage.java#L14) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.storage/index.md b/docs/api/org.mozilla.telemetry.storage/index.md new file mode 100644 index 00000000000..88f5225534e --- /dev/null +++ b/docs/api/org.mozilla.telemetry.storage/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [org.mozilla.telemetry.storage](./index.md) + +## Package org.mozilla.telemetry.storage + +### Types + +| Name | Summary | +|---|---| +| [FileTelemetryStorage](-file-telemetry-storage/index.md) | `open class FileTelemetryStorage : `[`TelemetryStorage`](-telemetry-storage/index.md)
TelemetryStorage implementation that stores pings as files on disk. | +| [TelemetryStorage](-telemetry-storage/index.md) | `interface TelemetryStorage` | diff --git a/docs/api/org.mozilla.telemetry.util/-context-utils/-init-.md b/docs/api/org.mozilla.telemetry.util/-context-utils/-init-.md new file mode 100644 index 00000000000..9f4e5478edc --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-context-utils/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.util](../index.md) / [ContextUtils](index.md) / [<init>](./-init-.md) + +# <init> + +`ContextUtils()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.util/-context-utils/get-app-name.md b/docs/api/org.mozilla.telemetry.util/-context-utils/get-app-name.md new file mode 100644 index 00000000000..5ff25845f4d --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-context-utils/get-app-name.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.util](../index.md) / [ContextUtils](index.md) / [getAppName](./get-app-name.md) + +# getAppName + +`open static fun getAppName(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/util/ContextUtils.java#L23) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.util/-context-utils/get-version-code.md b/docs/api/org.mozilla.telemetry.util/-context-utils/get-version-code.md new file mode 100644 index 00000000000..542ebb8c45f --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-context-utils/get-version-code.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.util](../index.md) / [ContextUtils](index.md) / [getVersionCode](./get-version-code.md) + +# getVersionCode + +`open static fun getVersionCode(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/util/ContextUtils.java#L19) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.util/-context-utils/get-version-name.md b/docs/api/org.mozilla.telemetry.util/-context-utils/get-version-name.md new file mode 100644 index 00000000000..562fac7a9ca --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-context-utils/get-version-name.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.util](../index.md) / [ContextUtils](index.md) / [getVersionName](./get-version-name.md) + +# getVersionName + +`open static fun getVersionName(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/util/ContextUtils.java#L15) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.util/-context-utils/index.md b/docs/api/org.mozilla.telemetry.util/-context-utils/index.md new file mode 100644 index 00000000000..f79db038d76 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-context-utils/index.md @@ -0,0 +1,19 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.util](../index.md) / [ContextUtils](./index.md) + +# ContextUtils + +`open class ContextUtils` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/util/ContextUtils.java#L14) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `ContextUtils()` | + +### Functions + +| Name | Summary | +|---|---| +| [getAppName](get-app-name.md) | `open static fun getAppName(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getVersionCode](get-version-code.md) | `open static fun getVersionCode(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [getVersionName](get-version-name.md) | `open static fun getVersionName(context: `[`Context`](https://developer.android.com/reference/android/content/Context.html)`): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/api/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/-init-.md b/docs/api/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/-init-.md new file mode 100644 index 00000000000..83417712f71 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.util](../../index.md) / [FileUtils](../index.md) / [FileLastModifiedComparator](index.md) / [<init>](./-init-.md) + +# <init> + +`FileLastModifiedComparator()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/compare.md b/docs/api/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/compare.md new file mode 100644 index 00000000000..de838d0d914 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/compare.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.util](../../index.md) / [FileUtils](../index.md) / [FileLastModifiedComparator](index.md) / [compare](./compare.md) + +# compare + +`open fun compare(lhs: `[`File`](https://developer.android.com/reference/java/io/File.html)`, rhs: `[`File`](https://developer.android.com/reference/java/io/File.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/util/FileUtils.java#L54) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/index.md b/docs/api/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/index.md new file mode 100644 index 00000000000..4e2db77c93e --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-file-utils/-file-last-modified-comparator/index.md @@ -0,0 +1,17 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.util](../../index.md) / [FileUtils](../index.md) / [FileLastModifiedComparator](./index.md) + +# FileLastModifiedComparator + +`open class FileLastModifiedComparator : `[`Comparator`](https://developer.android.com/reference/java/util/Comparator.html)`<`[`File`](https://developer.android.com/reference/java/io/File.html)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/util/FileUtils.java#L52) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FileLastModifiedComparator()` | + +### Functions + +| Name | Summary | +|---|---| +| [compare](compare.md) | `open fun compare(lhs: `[`File`](https://developer.android.com/reference/java/io/File.html)`, rhs: `[`File`](https://developer.android.com/reference/java/io/File.html)`): `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/api/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/-init-.md b/docs/api/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/-init-.md new file mode 100644 index 00000000000..5f70dd2f4c9 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.util](../../index.md) / [FileUtils](../index.md) / [FilenameRegexFilter](index.md) / [<init>](./-init-.md) + +# <init> + +`FilenameRegexFilter(pattern: `[`Pattern`](https://developer.android.com/reference/java/util/regex/Pattern.html)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/accept.md b/docs/api/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/accept.md new file mode 100644 index 00000000000..933bd205ec5 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/accept.md @@ -0,0 +1,5 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.util](../../index.md) / [FileUtils](../index.md) / [FilenameRegexFilter](index.md) / [accept](./accept.md) + +# accept + +`open fun accept(dir: `[`File`](https://developer.android.com/reference/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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/util/FileUtils.java#L42) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/index.md b/docs/api/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/index.md new file mode 100644 index 00000000000..e201a541ac6 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-file-utils/-filename-regex-filter/index.md @@ -0,0 +1,17 @@ +[android-components](../../../index.md) / [org.mozilla.telemetry.util](../../index.md) / [FileUtils](../index.md) / [FilenameRegexFilter](./index.md) + +# FilenameRegexFilter + +`open class FilenameRegexFilter : `[`FilenameFilter`](https://developer.android.com/reference/java/io/FilenameFilter.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/util/FileUtils.java#L29) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FilenameRegexFilter(pattern: `[`Pattern`](https://developer.android.com/reference/java/util/regex/Pattern.html)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [accept](accept.md) | `open fun accept(dir: `[`File`](https://developer.android.com/reference/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/org.mozilla.telemetry.util/-file-utils/-init-.md b/docs/api/org.mozilla.telemetry.util/-file-utils/-init-.md new file mode 100644 index 00000000000..d85ce5598bc --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-file-utils/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.util](../index.md) / [FileUtils](index.md) / [<init>](./-init-.md) + +# <init> + +`FileUtils()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.util/-file-utils/assert-directory.md b/docs/api/org.mozilla.telemetry.util/-file-utils/assert-directory.md new file mode 100644 index 00000000000..d641b3f3b2a --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-file-utils/assert-directory.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.util](../index.md) / [FileUtils](index.md) / [assertDirectory](./assert-directory.md) + +# assertDirectory + +`open static fun assertDirectory(directory: `[`File`](https://developer.android.com/reference/java/io/File.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/util/FileUtils.java#L17) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.util/-file-utils/index.md b/docs/api/org.mozilla.telemetry.util/-file-utils/index.md new file mode 100644 index 00000000000..264c8fe2016 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-file-utils/index.md @@ -0,0 +1,24 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.util](../index.md) / [FileUtils](./index.md) + +# FileUtils + +`open class FileUtils` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/util/FileUtils.java#L16) + +### Types + +| Name | Summary | +|---|---| +| [FileLastModifiedComparator](-file-last-modified-comparator/index.md) | `open class FileLastModifiedComparator : `[`Comparator`](https://developer.android.com/reference/java/util/Comparator.html)`<`[`File`](https://developer.android.com/reference/java/io/File.html)`>` | +| [FilenameRegexFilter](-filename-regex-filter/index.md) | `open class FilenameRegexFilter : `[`FilenameFilter`](https://developer.android.com/reference/java/io/FilenameFilter.html) | + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `FileUtils()` | + +### Functions + +| Name | Summary | +|---|---| +| [assertDirectory](assert-directory.md) | `open static fun assertDirectory(directory: `[`File`](https://developer.android.com/reference/java/io/File.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/org.mozilla.telemetry.util/-i-o-utils/-init-.md b/docs/api/org.mozilla.telemetry.util/-i-o-utils/-init-.md new file mode 100644 index 00000000000..d40a62b2a42 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-i-o-utils/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.util](../index.md) / [IOUtils](index.md) / [<init>](./-init-.md) + +# <init> + +`IOUtils()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.util/-i-o-utils/index.md b/docs/api/org.mozilla.telemetry.util/-i-o-utils/index.md new file mode 100644 index 00000000000..ea67d583bb3 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-i-o-utils/index.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.util](../index.md) / [IOUtils](./index.md) + +# IOUtils + +`open class IOUtils` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/util/IOUtils.java#L13) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `IOUtils()` | + +### Functions + +| Name | Summary | +|---|---| +| [safeClose](safe-close.md) | `open static fun safeClose(stream: `[`Closeable`](https://developer.android.com/reference/java/io/Closeable.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/org.mozilla.telemetry.util/-i-o-utils/safe-close.md b/docs/api/org.mozilla.telemetry.util/-i-o-utils/safe-close.md new file mode 100644 index 00000000000..a1d8f933207 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-i-o-utils/safe-close.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.util](../index.md) / [IOUtils](index.md) / [safeClose](./safe-close.md) + +# safeClose + +`open static fun safeClose(stream: `[`Closeable`](https://developer.android.com/reference/java/io/Closeable.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/util/IOUtils.java#L14) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.util/-string-utils/-init-.md b/docs/api/org.mozilla.telemetry.util/-string-utils/-init-.md new file mode 100644 index 00000000000..939a985d1d4 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-string-utils/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.util](../index.md) / [StringUtils](index.md) / [<init>](./-init-.md) + +# <init> + +`StringUtils()` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.util/-string-utils/index.md b/docs/api/org.mozilla.telemetry.util/-string-utils/index.md new file mode 100644 index 00000000000..018a8768de2 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-string-utils/index.md @@ -0,0 +1,17 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.util](../index.md) / [StringUtils](./index.md) + +# StringUtils + +`open class StringUtils` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/util/StringUtils.java#L11) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `StringUtils()` | + +### Functions + +| Name | Summary | +|---|---| +| [safeSubstring](safe-substring.md) | `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/org.mozilla.telemetry.util/-string-utils/safe-substring.md b/docs/api/org.mozilla.telemetry.util/-string-utils/safe-substring.md new file mode 100644 index 00000000000..a9912a7a14f --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/-string-utils/safe-substring.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry.util](../index.md) / [StringUtils](index.md) / [safeSubstring](./safe-substring.md) + +# 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) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/util/StringUtils.java#L12) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry.util/index.md b/docs/api/org.mozilla.telemetry.util/index.md new file mode 100644 index 00000000000..712ed238660 --- /dev/null +++ b/docs/api/org.mozilla.telemetry.util/index.md @@ -0,0 +1,12 @@ +[android-components](../index.md) / [org.mozilla.telemetry.util](./index.md) + +## Package org.mozilla.telemetry.util + +### Types + +| Name | Summary | +|---|---| +| [ContextUtils](-context-utils/index.md) | `open class ContextUtils` | +| [FileUtils](-file-utils/index.md) | `open class FileUtils` | +| [IOUtils](-i-o-utils/index.md) | `open class IOUtils` | +| [StringUtils](-string-utils/index.md) | `open class StringUtils` | diff --git a/docs/api/org.mozilla.telemetry/-telemetry-holder/-init-.md b/docs/api/org.mozilla.telemetry/-telemetry-holder/-init-.md new file mode 100644 index 00000000000..49b67403e48 --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry-holder/-init-.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [TelemetryHolder](index.md) / [<init>](./-init-.md) + +# <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/org.mozilla.telemetry/-telemetry-holder/get.md b/docs/api/org.mozilla.telemetry/-telemetry-holder/get.md new file mode 100644 index 00000000000..8d48ac3f2cb --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry-holder/get.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [TelemetryHolder](index.md) / [get](./get.md) + +# get + +`open static fun get(): `[`Telemetry`](../-telemetry/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/TelemetryHolder.java#L19) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry/-telemetry-holder/index.md b/docs/api/org.mozilla.telemetry/-telemetry-holder/index.md new file mode 100644 index 00000000000..f7491d55f27 --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry-holder/index.md @@ -0,0 +1,20 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [TelemetryHolder](./index.md) + +# TelemetryHolder + +`open class TelemetryHolder` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/TelemetryHolder.java#L12) + +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 + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `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 + +| Name | Summary | +|---|---| +| [get](get.md) | `open static fun get(): `[`Telemetry`](../-telemetry/index.md) | +| [set](set.md) | `open static fun set(telemetry: `[`Telemetry`](../-telemetry/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | diff --git a/docs/api/org.mozilla.telemetry/-telemetry-holder/set.md b/docs/api/org.mozilla.telemetry/-telemetry-holder/set.md new file mode 100644 index 00000000000..b3c9f593ce6 --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry-holder/set.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [TelemetryHolder](index.md) / [set](./set.md) + +# set + +`open static fun set(telemetry: `[`Telemetry`](../-telemetry/index.md)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/TelemetryHolder.java#L15) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry/-telemetry/-init-.md b/docs/api/org.mozilla.telemetry/-telemetry/-init-.md new file mode 100644 index 00000000000..62ab45c40f4 --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/-init-.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](index.md) / [<init>](./-init-.md) + +# <init> + +`Telemetry(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`, storage: `[`TelemetryStorage`](../../org.mozilla.telemetry.storage/-telemetry-storage/index.md)`, client: `[`TelemetryClient`](../../org.mozilla.telemetry.net/-telemetry-client/index.md)`, scheduler: `[`TelemetryScheduler`](../../org.mozilla.telemetry.schedule/-telemetry-scheduler/index.md)`)` \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry/-telemetry/add-ping-builder.md b/docs/api/org.mozilla.telemetry/-telemetry/add-ping-builder.md new file mode 100644 index 00000000000..489c0102a88 --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/add-ping-builder.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](index.md) / [addPingBuilder](./add-ping-builder.md) + +# addPingBuilder + +`open fun addPingBuilder(builder: `[`TelemetryPingBuilder`](../../org.mozilla.telemetry.ping/-telemetry-ping-builder/index.md)`): `[`Telemetry`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L57) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry/-telemetry/get-builders.md b/docs/api/org.mozilla.telemetry/-telemetry/get-builders.md new file mode 100644 index 00000000000..ed4e8cf5a08 --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/get-builders.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](index.md) / [getBuilders](./get-builders.md) + +# 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.md)`>` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L130) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry/-telemetry/get-client-id.md b/docs/api/org.mozilla.telemetry/-telemetry/get-client-id.md new file mode 100644 index 00000000000..59f5ef55c26 --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/get-client-id.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](index.md) / [getClientId](./get-client-id.md) + +# getClientId + +`open fun getClientId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L299) + +Returns the unique client id for this installation (UUID). + diff --git a/docs/api/org.mozilla.telemetry/-telemetry/get-client.md b/docs/api/org.mozilla.telemetry/-telemetry/get-client.md new file mode 100644 index 00000000000..8773fdb6ecb --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/get-client.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](index.md) / [getClient](./get-client.md) + +# getClient + +`open fun getClient(): `[`TelemetryClient`](../../org.mozilla.telemetry.net/-telemetry-client/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L284) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry/-telemetry/get-configuration.md b/docs/api/org.mozilla.telemetry/-telemetry/get-configuration.md new file mode 100644 index 00000000000..18815104af5 --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/get-configuration.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](index.md) / [getConfiguration](./get-configuration.md) + +# getConfiguration + +`open fun getConfiguration(): `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L292) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry/-telemetry/get-ping-builder.md b/docs/api/org.mozilla.telemetry/-telemetry/get-ping-builder.md new file mode 100644 index 00000000000..4195b72f34d --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/get-ping-builder.md @@ -0,0 +1,8 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](index.md) / [getPingBuilder](./get-ping-builder.md) + +# getPingBuilder + +`@Nullable open fun getPingBuilder(pingType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryPingBuilder`](../../org.mozilla.telemetry.ping/-telemetry-ping-builder/index.md)`?` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L66) + +Returns a previously added ping builder or null if no ping builder of the given type has been added. + diff --git a/docs/api/org.mozilla.telemetry/-telemetry/get-storage.md b/docs/api/org.mozilla.telemetry/-telemetry/get-storage.md new file mode 100644 index 00000000000..f457e51fa2b --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/get-storage.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](index.md) / [getStorage](./get-storage.md) + +# getStorage + +`open fun getStorage(): `[`TelemetryStorage`](../../org.mozilla.telemetry.storage/-telemetry-storage/index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L288) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry/-telemetry/index.md b/docs/api/org.mozilla.telemetry/-telemetry/index.md new file mode 100644 index 00000000000..1947ca0532a --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/index.md @@ -0,0 +1,32 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](./index.md) + +# Telemetry + +`open class Telemetry` [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L38) + +### Constructors + +| Name | Summary | +|---|---| +| [<init>](-init-.md) | `Telemetry(configuration: `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md)`, storage: `[`TelemetryStorage`](../../org.mozilla.telemetry.storage/-telemetry-storage/index.md)`, client: `[`TelemetryClient`](../../org.mozilla.telemetry.net/-telemetry-client/index.md)`, scheduler: `[`TelemetryScheduler`](../../org.mozilla.telemetry.schedule/-telemetry-scheduler/index.md)`)` | + +### Functions + +| Name | Summary | +|---|---| +| [addPingBuilder](add-ping-builder.md) | `open fun addPingBuilder(builder: `[`TelemetryPingBuilder`](../../org.mozilla.telemetry.ping/-telemetry-ping-builder/index.md)`): `[`Telemetry`](./index.md) | +| [getBuilders](get-builders.md) | `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.md)`>` | +| [getClient](get-client.md) | `open fun getClient(): `[`TelemetryClient`](../../org.mozilla.telemetry.net/-telemetry-client/index.md) | +| [getClientId](get-client-id.md) | `open fun getClientId(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Returns the unique client id for this installation (UUID). | +| [getConfiguration](get-configuration.md) | `open fun getConfiguration(): `[`TelemetryConfiguration`](../../org.mozilla.telemetry.config/-telemetry-configuration/index.md) | +| [getPingBuilder](get-ping-builder.md) | `open fun getPingBuilder(pingType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`TelemetryPingBuilder`](../../org.mozilla.telemetry.ping/-telemetry-ping-builder/index.md)`?`
Returns a previously added ping builder or null if no ping builder of the given type has been added. | +| [getStorage](get-storage.md) | `open fun getStorage(): `[`TelemetryStorage`](../../org.mozilla.telemetry.storage/-telemetry-storage/index.md) | +| [queueEvent](queue-event.md) | `open fun queueEvent(event: `[`TelemetryEvent`](../../org.mozilla.telemetry.event/-telemetry-event/index.md)`): `[`Telemetry`](./index.md) | +| [queuePing](queue-ping.md) | `open fun queuePing(pingType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Telemetry`](./index.md) | +| [recordActiveExperiments](record-active-experiments.md) | `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 | +| [recordExperiments](record-experiments.md) | `open fun recordExperiments(experiments: `[`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)`, `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>): `[`Telemetry`](./index.md)
Records all experiments the client knows of in the event ping. | +| [recordSearch](record-search.md) | `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.md) | `open fun recordSessionEnd(onFailure: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Telemetry`](./index.md)
`open fun recordSessionEnd(): `[`Telemetry`](./index.md) | +| [recordSessionStart](record-session-start.md) | `open fun recordSessionStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | +| [scheduleUpload](schedule-upload.md) | `open fun scheduleUpload(): `[`Telemetry`](./index.md) | +| [setDefaultSearchProvider](set-default-search-provider.md) | `open fun setDefaultSearchProvider(provider: `[`DefaultSearchEngineProvider`](../../org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/index.md)`): `[`Telemetry`](./index.md) | diff --git a/docs/api/org.mozilla.telemetry/-telemetry/queue-event.md b/docs/api/org.mozilla.telemetry/-telemetry/queue-event.md new file mode 100644 index 00000000000..4ff920a0a44 --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/queue-event.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](index.md) / [queueEvent](./queue-event.md) + +# queueEvent + +`open fun queueEvent(event: `[`TelemetryEvent`](../../org.mozilla.telemetry.event/-telemetry-event/index.md)`): `[`Telemetry`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L95) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry/-telemetry/queue-ping.md b/docs/api/org.mozilla.telemetry/-telemetry/queue-ping.md new file mode 100644 index 00000000000..73654007251 --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/queue-ping.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](index.md) / [queuePing](./queue-ping.md) + +# queuePing + +`open fun queuePing(pingType: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Telemetry`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L70) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry/-telemetry/record-active-experiments.md b/docs/api/org.mozilla.telemetry/-telemetry/record-active-experiments.md new file mode 100644 index 00000000000..c56a92d077a --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/record-active-experiments.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](index.md) / [recordActiveExperiments](./record-active-experiments.md) + +# 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.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L225) + +Records the list of active experiments + +### Parameters + +`activeExperimentsIds` - list of active experiments ids \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry/-telemetry/record-experiments.md b/docs/api/org.mozilla.telemetry/-telemetry/record-experiments.md new file mode 100644 index 00000000000..a69e9d614c9 --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/record-experiments.md @@ -0,0 +1,11 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](index.md) / [recordExperiments](./record-experiments.md) + +# recordExperiments + +`open fun recordExperiments(experiments: `[`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)`, `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`>): `[`Telemetry`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L248) + +Records all experiments the client knows of in the event ping. + +### Parameters + +`experiments` - A map of experiments the client knows of. Mapping experiment name to a Boolean value that is true if the client is part of the experiment and false if the client is not part of the experiment. \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry/-telemetry/record-search.md b/docs/api/org.mozilla.telemetry/-telemetry/record-search.md new file mode 100644 index 00000000000..6a9193a801f --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/record-search.md @@ -0,0 +1,13 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](index.md) / [recordSearch](./record-search.md) + +# 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.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L204) + +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/org.mozilla.telemetry/-telemetry/record-session-end.md b/docs/api/org.mozilla.telemetry/-telemetry/record-session-end.md new file mode 100644 index 00000000000..341a1240d91 --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/record-session-end.md @@ -0,0 +1,6 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](index.md) / [recordSessionEnd](./record-session-end.md) + +# recordSessionEnd + +`open fun recordSessionEnd(onFailure: () -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`Telemetry`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L163) +`open fun recordSessionEnd(): `[`Telemetry`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L181) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry/-telemetry/record-session-start.md b/docs/api/org.mozilla.telemetry/-telemetry/record-session-start.md new file mode 100644 index 00000000000..3bd166151b8 --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/record-session-start.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](index.md) / [recordSessionStart](./record-session-start.md) + +# recordSessionStart + +`open fun recordSessionStart(): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L148) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry/-telemetry/schedule-upload.md b/docs/api/org.mozilla.telemetry/-telemetry/schedule-upload.md new file mode 100644 index 00000000000..416cedfab8e --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/schedule-upload.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](index.md) / [scheduleUpload](./schedule-upload.md) + +# scheduleUpload + +`open fun scheduleUpload(): `[`Telemetry`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L134) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry/-telemetry/set-default-search-provider.md b/docs/api/org.mozilla.telemetry/-telemetry/set-default-search-provider.md new file mode 100644 index 00000000000..e0e59fc5c44 --- /dev/null +++ b/docs/api/org.mozilla.telemetry/-telemetry/set-default-search-provider.md @@ -0,0 +1,5 @@ +[android-components](../../index.md) / [org.mozilla.telemetry](../index.md) / [Telemetry](index.md) / [setDefaultSearchProvider](./set-default-search-provider.md) + +# setDefaultSearchProvider + +`open fun setDefaultSearchProvider(provider: `[`DefaultSearchEngineProvider`](../../org.mozilla.telemetry.measurement/-default-search-measurement/-default-search-engine-provider/index.md)`): `[`Telemetry`](index.md) [(source)](https://github.com/mozilla-mobile/android-components/blob/master/components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java#L272) \ No newline at end of file diff --git a/docs/api/org.mozilla.telemetry/index.md b/docs/api/org.mozilla.telemetry/index.md new file mode 100644 index 00000000000..c4e2de829f3 --- /dev/null +++ b/docs/api/org.mozilla.telemetry/index.md @@ -0,0 +1,10 @@ +[android-components](../index.md) / [org.mozilla.telemetry](./index.md) + +## Package org.mozilla.telemetry + +### Types + +| Name | Summary | +|---|---| +| [Telemetry](-telemetry/index.md) | `open class Telemetry` | +| [TelemetryHolder](-telemetry-holder/index.md) | `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/package-list b/docs/api/package-list new file mode 100644 index 00000000000..466e9ecc21e --- /dev/null +++ b/docs/api/package-list @@ -0,0 +1,176 @@ +$dokka.format:gfm +$dokka.linkExtension:md +$dokka.location:mozilla.components.browser.engine.system.matcher$reverse(kotlin.String)mozilla.components.browser.engine.system.matcher/kotlin.-string/reverse.md +$dokka.location:mozilla.components.browser.engine.system.matcher$reversible(kotlin.String)mozilla.components.browser.engine.system.matcher/kotlin.-string/reversible.md +$dokka.location:mozilla.components.lib.jexl.ext$toJexl(kotlin.Boolean)mozilla.components.lib.jexl.ext/kotlin.-boolean/to-jexl.md +$dokka.location:mozilla.components.lib.jexl.ext$toJexl(kotlin.Double)mozilla.components.lib.jexl.ext/kotlin.-double/to-jexl.md +$dokka.location:mozilla.components.lib.jexl.ext$toJexl(kotlin.Float)mozilla.components.lib.jexl.ext/kotlin.-float/to-jexl.md +$dokka.location:mozilla.components.lib.jexl.ext$toJexl(kotlin.Int)mozilla.components.lib.jexl.ext/kotlin.-int/to-jexl.md +$dokka.location:mozilla.components.lib.jexl.ext$toJexl(kotlin.String)mozilla.components.lib.jexl.ext/kotlin.-string/to-jexl.md +$dokka.location:mozilla.components.lib.jexl.ext$toJexlArray(kotlin.collections.List((mozilla.components.lib.jexl.ext.toJexlArray.T)))mozilla.components.lib.jexl.ext/kotlin.collections.-list/to-jexl-array.md +$dokka.location:mozilla.components.support.ktx.android.arch.lifecycle$addObservers(android.arch.lifecycle.Lifecycle, kotlin.Array((android.arch.lifecycle.LifecycleObserver)))mozilla.components.support.ktx.android.arch.lifecycle/android.arch.lifecycle.-lifecycle/add-observers.md +$dokka.location:mozilla.components.support.ktx.android.content$appVersionName#android.content.Contextmozilla.components.support.ktx.android.content/android.content.-context/app-version-name.md +$dokka.location:mozilla.components.support.ktx.android.content$isOSOnLowMemory(android.content.Context)mozilla.components.support.ktx.android.content/android.content.-context/is-o-s-on-low-memory.md +$dokka.location:mozilla.components.support.ktx.android.content$isPermissionGranted(android.content.Context, kotlin.Array((kotlin.String)))mozilla.components.support.ktx.android.content/android.content.-context/is-permission-granted.md +$dokka.location:mozilla.components.support.ktx.android.content$share(android.content.Context, kotlin.String, kotlin.String)mozilla.components.support.ktx.android.content/android.content.-context/share.md +$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.md +$dokka.location:mozilla.components.support.ktx.android.content.res$pxToDp(android.content.res.Resources, kotlin.Int)mozilla.components.support.ktx.android.content.res/android.content.res.-resources/px-to-dp.md +$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.md +$dokka.location:mozilla.components.support.ktx.android.graphics$toDataUri(android.graphics.Bitmap)mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/to-data-uri.md +$dokka.location:mozilla.components.support.ktx.android.graphics$withRoundedCorners(android.graphics.Bitmap, kotlin.Float)mozilla.components.support.ktx.android.graphics/android.graphics.-bitmap/with-rounded-corners.md +$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.md +$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.md +$dokka.location:mozilla.components.support.ktx.android.org.json$mergeWith(org.json.JSONObject, org.json.JSONObject)mozilla.components.support.ktx.android.org.json/org.json.-j-s-o-n-object/merge-with.md +$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.md +$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.md +$dokka.location:mozilla.components.support.ktx.android.org.json$toJSON(kotlin.collections.Map((kotlin.String, )))mozilla.components.support.ktx.android.org.json/kotlin.collections.-map/to-j-s-o-n.md +$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.md +$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.md +$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.md +$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.md +$dokka.location:mozilla.components.support.ktx.android.os$resetAfter(android.os.StrictMode.ThreadPolicy, kotlin.Function0((mozilla.components.support.ktx.android.os.resetAfter.R)))mozilla.components.support.ktx.android.os/android.os.-strict-mode.-thread-policy/reset-after.md +$dokka.location:mozilla.components.support.ktx.android.view$enterToImmersiveMode(android.app.Activity)mozilla.components.support.ktx.android.view/android.app.-activity/enter-to-immersive-mode.md +$dokka.location:mozilla.components.support.ktx.android.view$exitImmersiveModeIfNeeded(android.app.Activity)mozilla.components.support.ktx.android.view/android.app.-activity/exit-immersive-mode-if-needed.md +$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.md +$dokka.location:mozilla.components.support.ktx.android.view$hideKeyboard(android.view.View)mozilla.components.support.ktx.android.view/android.view.-view/hide-keyboard.md +$dokka.location:mozilla.components.support.ktx.android.view$isGone(android.view.View)mozilla.components.support.ktx.android.view/android.view.-view/is-gone.md +$dokka.location:mozilla.components.support.ktx.android.view$isInvisible(android.view.View)mozilla.components.support.ktx.android.view/android.view.-view/is-invisible.md +$dokka.location:mozilla.components.support.ktx.android.view$isLTR#android.view.Viewmozilla.components.support.ktx.android.view/android.view.-view/is-l-t-r.md +$dokka.location:mozilla.components.support.ktx.android.view$isRTL#android.view.Viewmozilla.components.support.ktx.android.view/android.view.-view/is-r-t-l.md +$dokka.location:mozilla.components.support.ktx.android.view$isVisible(android.view.View)mozilla.components.support.ktx.android.view/android.view.-view/is-visible.md +$dokka.location:mozilla.components.support.ktx.android.view$setPadding(android.view.View, mozilla.components.support.base.android.Padding)mozilla.components.support.ktx.android.view/android.view.-view/set-padding.md +$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.md +$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.md +$dokka.location:mozilla.components.support.ktx.kotlin$isEmail(kotlin.String)mozilla.components.support.ktx.kotlin/kotlin.-string/is-email.md +$dokka.location:mozilla.components.support.ktx.kotlin$isGeoLocation(kotlin.String)mozilla.components.support.ktx.kotlin/kotlin.-string/is-geo-location.md +$dokka.location:mozilla.components.support.ktx.kotlin$isPhone(kotlin.String)mozilla.components.support.ktx.kotlin/kotlin.-string/is-phone.md +$dokka.location:mozilla.components.support.ktx.kotlin$isUrl(kotlin.String)mozilla.components.support.ktx.kotlin/kotlin.-string/is-url.md +$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.md +$dokka.location:mozilla.components.support.ktx.kotlin$toDate(kotlin.String, kotlin.String, java.util.Locale)mozilla.components.support.ktx.kotlin/kotlin.-string/to-date.md +$dokka.location:mozilla.components.support.ktx.kotlin$toNormalizedUrl(kotlin.String)mozilla.components.support.ktx.kotlin/kotlin.-string/to-normalized-url.md +mozilla.components.browser.awesomebar +mozilla.components.browser.awesomebar.layout +mozilla.components.browser.awesomebar.transform +mozilla.components.browser.domains +mozilla.components.browser.domains.autocomplete +mozilla.components.browser.engine.gecko +mozilla.components.browser.engine.gecko.fetch +mozilla.components.browser.engine.gecko.permission +mozilla.components.browser.engine.gecko.prompt +mozilla.components.browser.engine.servo +mozilla.components.browser.engine.system +mozilla.components.browser.engine.system.matcher +mozilla.components.browser.engine.system.permission +mozilla.components.browser.engine.system.window +mozilla.components.browser.errorpages +mozilla.components.browser.menu +mozilla.components.browser.menu.item +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 +mozilla.components.browser.session +mozilla.components.browser.session.storage +mozilla.components.browser.session.tab +mozilla.components.browser.storage.memory +mozilla.components.browser.storage.sync +mozilla.components.browser.tabstray +mozilla.components.browser.toolbar +mozilla.components.browser.toolbar.behavior +mozilla.components.browser.toolbar.edit +mozilla.components.concept.awesomebar +mozilla.components.concept.engine +mozilla.components.concept.engine.history +mozilla.components.concept.engine.permission +mozilla.components.concept.engine.prompt +mozilla.components.concept.engine.request +mozilla.components.concept.engine.window +mozilla.components.concept.fetch +mozilla.components.concept.storage +mozilla.components.concept.tabstray +mozilla.components.concept.toolbar +mozilla.components.feature.accounts +mozilla.components.feature.awesomebar +mozilla.components.feature.awesomebar.provider +mozilla.components.feature.contextmenu +mozilla.components.feature.customtabs +mozilla.components.feature.downloads +mozilla.components.feature.findinpage +mozilla.components.feature.findinpage.view +mozilla.components.feature.intent +mozilla.components.feature.prompts +mozilla.components.feature.search +mozilla.components.feature.session +mozilla.components.feature.session.bundling +mozilla.components.feature.sitepermissions +mozilla.components.feature.sync +mozilla.components.feature.tabs +mozilla.components.feature.tabs.tabstray +mozilla.components.feature.tabs.toolbar +mozilla.components.feature.toolbar +mozilla.components.lib.crash +mozilla.components.lib.crash.handler +mozilla.components.lib.crash.prompt +mozilla.components.lib.crash.service +mozilla.components.lib.dataprotect +mozilla.components.lib.fetch.httpurlconnection +mozilla.components.lib.fetch.okhttp +mozilla.components.lib.jexl +mozilla.components.lib.jexl.ast +mozilla.components.lib.jexl.evaluator +mozilla.components.lib.jexl.ext +mozilla.components.lib.jexl.grammar +mozilla.components.lib.jexl.lexer +mozilla.components.lib.jexl.parser +mozilla.components.lib.jexl.value +mozilla.components.lib.publicsuffixlist +mozilla.components.service.fretboard +mozilla.components.service.fretboard.scheduler.jobscheduler +mozilla.components.service.fretboard.scheduler.workmanager +mozilla.components.service.fretboard.source.kinto +mozilla.components.service.fretboard.storage.flatfile +mozilla.components.service.fxa +mozilla.components.service.glean +mozilla.components.service.glean.config +mozilla.components.service.glean.storages +mozilla.components.service.sync.logins +mozilla.components.support.base.android +mozilla.components.support.base.facts +mozilla.components.support.base.facts.processor +mozilla.components.support.base.feature +mozilla.components.support.base.log +mozilla.components.support.base.log.logger +mozilla.components.support.base.log.sink +mozilla.components.support.base.observer +mozilla.components.support.ktx.android.arch.lifecycle +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.os +mozilla.components.support.ktx.android.util +mozilla.components.support.ktx.android.view +mozilla.components.support.ktx.kotlin +mozilla.components.support.rustlog +mozilla.components.support.test +mozilla.components.support.test.robolectric +mozilla.components.support.utils +mozilla.components.tooling.fetch.tests +mozilla.components.tooling.lint +mozilla.components.ui.autocomplete +mozilla.components.ui.doorhanger +mozilla.components.ui.progress +mozilla.components.ui.tabcounter +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