luadocs/content/lua.api.manual/darktable/darktable.password.md
wpferguson fbebfabca5 [Lua API] Removed references to API 6.x.x. Updated version to 7.0.0.
Reordered types alphabetically.  Fixed darktable.gui.libs.snapshots
2021-06-22 22:40:54 -04:00

1.1 KiB

title id weight draft author
darktable.password darktable.password 140 false people

Store and retrieve credentials using the darktable password storage backend.

darktable.password.save

function(
  application : string,
  username : string,
  password : string
) :boolean

Save a username/password pair for use accessing an application.

  • application - string - Name of application or website.
  • username - string - The username used to access the application or website.
  • password - string - The credential used to authenticate the username.
  • return - boolean - True if the credentials are saved, false if they are not.

darktable.password.get

function(
  application : string,
  username : string
) :string

Retrieves the password associated with the username for the application.

  • application - string - Name of application or website.
  • username - string - The username used to access the application or website.
  • return - string - The credentials used to authenticate the user. Nil is returned if there is an error or the crendentials don't exist.