Initialize the component.
At present, other methods of this interface may be called before the
returned promise is resolved or rejected.
| {Promise} @resolves When initialization is complete. @rejects JavaScript exception. |
Ensures that all data has been written to disk and all files are closed.
At present, this method is called by regression tests only. Finalization
on shutdown is done by observers within the component.
| {Promise} @resolves When finalization is complete. @rejects JavaScript exception. |
Store a new login in the storage module.
Default values for the login’s nsILoginMetaInfo properties will be
created. However, if the caller specifies non-default values, they will
be used instead.
| aLogin | The login to be added. |
Remove a login from the storage module.
The specified login must exactly match a stored login. However, the
values of any nsILoginMetaInfo properties are ignored.
| aLogin | The login to be removed. |
Modify an existing login in the storage module.
If newLoginData is a nsILoginInfo, all of the old login’s nsILoginInfo
properties are changed to the values from newLoginData (but the old
login’s nsILoginMetaInfo properties are unmodified).
If newLoginData is a nsIPropertyBag, only the specified properties
will be changed. The nsILoginMetaInfo properties of oldLogin can be
changed in this manner.
If the propertybag contains an item named “timesUsedIncrement”, the
login’s timesUsed property will be incremented by the item’s value.
| oldLogin | The login to be modified. |
| newLoginData | The new login values (either a nsILoginInfo or nsIProperyBag) |
Remove all stored logins.
The browser sanitization feature allows the user to clear any stored
passwords. This interface allows that to be done without getting each
login first (which might require knowing the master password).
Fetch all logins in the login manager. An array is always returned;
if there are no logins the array is empty.
NOTE: This can be called from JS as:
var logins = pwmgr.getAllLogins();
(|logins| is an array).
| count | The number of elements in the array. JS callers can simply use the array's .length property and omit this param. |
| logins | An array of nsILoginInfo objects. |
Search for logins in the login manager. An array is always returned;
if there are no logins the array is empty.
NOTE: This can be called from JS as:
var logins = pwmgr.searchLogins({}, matchData);
(|logins| is an array).
| count | The number of elements in the array. JS callers can simply use the array's .length property, and supply an dummy object for this out param. For example: |searchLogins({}, matchData)| |
| matchData | The data used to search. This does not follow the same requirements as findLogins for those fields. Wildcard matches are simply not specified. |
| logins | An array of nsILoginInfo objects. |
Obtain a list of all hosts for which password saving is disabled.
NOTE: This can be called from JS as:
var logins = pwmgr.getAllDisabledHosts();
| count | The number of elements in the array. JS callers can simply use the array's .length property and omit this param. |
| hostnames | An array of hostname strings, in origin URL format without a pathname. For example: "https://www.site.com". |
Check to see if saving logins has been disabled for a host.
| aHost | The hostname to check. This argument should be in the origin URL format, without a pathname. For example: "http://foo.com". |
Disable (or enable) storing logins for the specified host. When
disabled, the login manager will not prompt to store logins for
that host. Existing logins are not affected.
| aHost | The hostname to set. This argument should be in the origin URL format, without a pathname. For example: "http://foo.com". |
| isEnabled | Specify if saving logins should be enabled (true) or disabled (false) |
Search for logins matching the specified criteria. Called when looking
for logins that might be applicable to a form or authentication request.
NOTE: This can be called from JS as:
var logins = pwmgr.findLogins({}, hostname, …);
| count | The number of elements in the array. JS callers can simply use the array's .length property, and supply an dummy object for this out param. For example: |findLogins({}, hostname, ...)| |
| aHostname | The hostname to restrict searches to, in URL format. For example: "http://www.site.com". |
| aActionURL | For form logins, this argument should be the URL to which the form will be submitted. For protocol logins, specify null. |
| aHttpRealm | For protocol logins, this argument should be the HTTP Realm for which the login applies. This is obtained from the WWW-Authenticate header. See RFC2617. For form logins, specify null. |
| logins | An array of nsILoginInfo objects. |
Search for logins matching the specified criteria, as with
findLogins(). This interface only returns the number of matching
logins (and not the logins themselves), which allows a caller to
check for logins without causing the user to be prompted for a master
password to decrypt the logins.
| aHostname | The hostname to restrict searches to. Specify an empty string to match all hosts. A null value will not match any logins, and will thus always return a count of 0. |
| aActionURL | The URL to which a form login will be submitted. To match any form login, specify an empty string. To not match any form login, specify null. |
| aHttpRealm | The HTTP Realm for which the login applies. To match logins for any realm, specify an empty string. To not match logins for any realm, specify null. |
True when a master password prompt is being shown.
True when the master password has already been entered, and so a caller
can ask for decrypted logins without triggering a prompt.