diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/passwords.md | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/docs/passwords.md b/docs/passwords.md deleted file mode 100644 index 283c54b..0000000 --- a/docs/passwords.md +++ /dev/null @@ -1,51 +0,0 @@ -The `passwords` module provides access to the Firefox Password Manager. - -<api name="setPassword"> -@method -The `setPassword` method sets new authentication pair to the encrypted -Firefox's nsILoginManager. - -It is most useful for storing sensitive data with private information -to the store. It is most useful in situation where script would need -some personal information, but it is our responsibility to store it -securely. - -@param username {string} login name -@param pass {string} password -@param domain {string} hostname of the server we are connecting to as URL. -As for example "http://bugzilla.mozilla.org" -@param realm {string} String distinguishing this login to other ones for -the same hostname. - -@returns {string} -</api> - -<api name="getPassword"> -@method -The `getPassword` method returns the password specified by the -parameters of this function. - -@param username {string} login name -@param domain {string} the same as in `setPassword` method. -@param realm {string} the same as in `setPassword` method. - -@returns {string} -</api> - -<api name="removePassword"> -@method -The `removePassword` method remove the login information from the storage. -Note that the serach parameters of this function must much **EXACTLY** -parameters of the corresponding call to `setPassword`. - -@param username {string} login name -@param domain {string} the same as in `setPassword` method. -@param realm {string} the same as in `setPassword` method. - -@returns {string} -</api> - -Examples --------- - -For examples see `tests/test-password.js`
\ No newline at end of file |