com.alecdorrington.omnibrowser
Members list
Packages
Type members
Classlikes
Whether Firefox for Android may install an extension, as Firefox's add-on store records it from the extension's manifest.
Whether Firefox for Android may install an extension, as Firefox's add-on store records it from the extension's manifest.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class Supportedobject Unsupported
The background of an extension: the handlers of the events it responds to while no page of it need be open.
The background of an extension: the handlers of the events it responds to while no page of it need be open.
The browser starts the background when one of these events happens, and stops it again once it is idle, so it keeps nothing in memory between events. What it must remember belongs in Browser.Storage.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The browser, as the extension's background and pages see it.
A browser extension, defined by an object extending this class, which the sbt-omnibrowser plugin builds for each target browser.
A browser extension, defined by an object extending this class, which the sbt-omnibrowser plugin builds for each target browser.
Each part of the extension, its background, contentScripts, popup and options, is a method, so that it is built only when that part starts, and its code is bundled only where it runs. A content script's bundle holds what its own method reaches, and whatever the object's own values reach, so they should be only what every part shares, such as its Messages and StorageKeys.
Type parameters
- P
-
The extension's permissions, as an intersection of Permission types such as
Permission.Storage & Permission.Tabs, orAnyfor none. They are requested in the extension's manifest, and the code within the extension may use only the APIs that they grant.
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
The browser, as every part of the extension sees it, its content scripts included: with only some of its APIs.
The browser, as every part of the extension sees it, its content scripts included: with only some of its APIs.
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
trait Browsertrait TabBrowser
A script that the browser injects into each page that one of matches matches, at runAt, with access to only some of the browser's APIs, along with the stylesheets css, as paths among the extension's assets.
A script that the browser injects into each page that one of matches matches, at runAt, with access to only some of the browser's APIs, along with the stylesheets css, as paths among the extension's assets.
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
ContentScript.type
The data that an extension collects or sends elsewhere: the required kinds without which it cannot work, and the optional kinds that the user may refuse. Firefox shows them to the user on installing the extension, and its add-on store refuses extensions that do not declare them.
The data that an extension collects or sends elsewhere: the required kinds without which it cannot work, and the optional kinds that the user may refuse. Firefox shows them to the user on installing the extension, and its add-on store refuses extensions that do not declare them.
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
DataCollection.type
A kind of data that an extension may collect, as Firefox names it.
A kind of data that an extension may collect, as Firefox names it.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object TechnicalAndInteractionenum PersonalData
A database of the extension's in the browser's IndexedDB, named name, for more than Browser.Storage holds, read and written through Browser.Databases. Its object stores are those that the object extending it makes with store, each a val of it, so that every one is made before the database is first opened:
A database of the extension's in the browser's IndexedDB, named name, for more than Browser.Storage holds, read and written through Browser.Databases. Its object stores are those that the object extending it makes with store, each a val of it, so that every one is made before the database is first opened:
object Lexicon extends Database("lexicon", version = 1):
val lexemes = store[Lexeme]("lexemes")
val counts = store[Int]("counts")
The browser makes it with its stores the first time it is opened, and adds the stores that it lacks whenever it is opened at a version above its own, which must be raised whenever a store is added, and never lowered. A store left out stays in the database, unused, with what it kept.
Only the background and the extension's pages reach it: a content script's IndexedDB is the web page's, not the extension's, so its browser has no databases. No permission is needed. Without Permission.UnlimitedStorage, it has the browser's default quota, and the browser may evict it when the device runs short of space.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
A failure of the database named database, as when it cannot be opened, or a write cannot be kept, as when the browser has no room for it, for reason, the browser's own where it gave one.
A failure of the database named database, as when it cannot be opened, or a write cannot be kept, as when the browser has no room for it, for reason, the browser's own where it gave one.
Attributes
- Supertypes
-
trait Producttrait Equalsclass Exceptionclass Throwabletrait Serializableclass Objecttrait Matchableclass AnyShow all
Evidence that an extension has the permission Q, which the APIs that Q grants require.
Evidence that an extension has the permission Q, which the APIs that Q grants require.
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
Something that an extension's Background does when an event happens.
Something that an extension's Background does when an event happens.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Companion
- enum
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
InstallReason.type
Why an extension was installed.
Why an extension was installed.
Attributes
- Companion
- object
- Supertypes
-
trait Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A kind of message that one part of an extension sends the background, which BrowserExtension.serve answers. Its name must be unique among the extension's messages, and must not begin with omnibrowser/, which the library keeps for its own. Its requests and responses go as JSON, through circe's codecs.
A kind of message that one part of an extension sends the background, which BrowserExtension.serve answers. Its name must be unique among the extension's messages, and must not begin with omnibrowser/, which the library keeps for its own. Its requests and responses go as JSON, through circe's codecs.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
A failure to send or answer the message, or to read the shared value, named name.
A failure to send or answer the message, or to read the shared value, named name.
Attributes
- Supertypes
-
trait Producttrait Equalsclass Exceptionclass Throwabletrait Serializableclass Objecttrait Matchableclass AnyShow all
An object store of database, named name, which keeps values of type A, each as JSON, through circe's codecs, under a key of its own. Its keys are ordered as strings are, by their UTF-16 code units. A Database makes its own.
An object store of database, named name, which keeps values of type A, each as JSON, through circe's codecs, under a key of its own. Its keys are ordered as strings are, by their UTF-16 code units. A Database makes its own.
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
A page of the extension, whose body begins as the HTML body, styled by stylesheets, as paths among the extension's assets, and which run fills in once it has loaded.
A page of the extension, whose body begins as the HTML body, styled by stylesheets, as paths among the extension's assets, and which run fills in once it has loaded.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A permission that an extension may request, named in its manifest after its type, as activeTab for Permission.ActiveTab.
A permission that an extension may request, named in its manifest after its type, as activeTab for Permission.ActiveTab.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
Permission.type
The manifest names of the permissions in P, an intersection of Permission types, or Any for none.
The manifest names of the permissions in P, an intersection of Permission types, or Any for none.
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
Permissions.type
A kind of personal data, which an extension may require.
A kind of personal data, which an extension may require.
Attributes
- Supertypes
-
trait Enumtrait Serializabletrait Producttrait Equalstrait DataKindclass Objecttrait Matchableclass AnyShow all
When the browser injects a ContentScript into its page.
When the browser injects a ContentScript into its page.
Attributes
- Supertypes
-
trait Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Who sent a Message: a content script, in the tab of its page, or another part of the extension, at url.
Who sent a Message: a content script, in the tab of its page, or another part of the extension, at url.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Values that one part of an extension owns, and shares with the others, which see each new value as the owner gives it.
Values that one part of an extension owns, and shares with the others, which see each new value as the owner gives it.
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
Shared.type
Where the browser keeps the value of a StorageKey.
Where the browser keeps the value of a StorageKey.
Attributes
- Supertypes
-
trait Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A value that the extension keeps in the browser's storage, under name in area, which is default until it is first set. Its value is kept as JSON, through circe's codecs. A stored value that they cannot decode, as one that an earlier version stored differently, is default until it is set again, and the browser's console warns of it.
A value that the extension keeps in the browser's storage, under name in area, which is default until it is first set. Its value is kept as JSON, through circe's codecs. A stored value that they cannot decode, as one that an earlier version stored differently, is default until it is set again, and the browser's console warns of it.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
Attributes
- Companion
- class
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
StorageKey.type
A family of StorageKeys in area, each named prefix followed by a name of its own, as many as the extension needs, as one for each word that a user rates, each default until it is first set. Each is a key of its own, so that two parts of the extension setting two of them at once lose neither, and Browser.Storage.all reads every one that is stored. No family's prefix should begin another's in the same area, as count: begins count:x:, or the shorter would read the longer's keys as its own, as it would a key named apart that begins with its prefix.
A family of StorageKeys in area, each named prefix followed by a name of its own, as many as the extension needs, as one for each word that a user rates, each default until it is first set. Each is a key of its own, so that two parts of the extension setting two of them at once lose neither, and Browser.Storage.all reads every one that is stored. No family's prefix should begin another's in the same area, as count: begins count:x:, or the shorter would read the longer's keys as its own, as it would a key named apart that begins with its prefix.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
Attributes
- Companion
- class
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
StorageKeys.type
A tab of the browser. Its url and title are known only for pages that the extension may access, unless it has the Permission.Tabs permission.
A tab of the browser. Its url and title are known only for pages that the extension may access, unless it has the Permission.Tabs permission.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
The browser, as a content script sees it: with only some of its APIs, and with what the script offers the rest of the extension from its tab.
The browser, as a content script sees it: with only some of its APIs, and with what the script offers the rest of the extension from its tab.
Attributes
- Supertypes
A browser that an extension may be built for.
A browser that an extension may be built for.
Attributes
- Companion
- object
- Supertypes
-
trait Enumtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all