diff --git a/content/lua.api.manual/_index.html b/content/lua.api.manual/_index.html index d839900..9505b68 100644 --- a/content/lua.api.manual/_index.html +++ b/content/lua.api.manual/_index.html @@ -5,4 +5,3 @@ weight: 30 draft: false author: "people" --- - diff --git a/content/lua.api.manual/darktable/password.md b/content/lua.api.manual/darktable/password.md new file mode 100644 index 0000000..58cd704 --- /dev/null +++ b/content/lua.api.manual/darktable/password.md @@ -0,0 +1,42 @@ +--- +title: darktable.password +id: darktable.password +weight: 155 +draft: false +author: "people" +--- + +## Lua API 6.2.0 + +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. diff --git a/content/lua.api.manual/version.md b/content/lua.api.manual/version.md new file mode 100644 index 0000000..fe7a4d5 --- /dev/null +++ b/content/lua.api.manual/version.md @@ -0,0 +1,15 @@ +--- +title: Lua API Version +id: Lua API Version +weight: 10 +draft: false +author: "people" +--- + +# Current API + +The Lua API version currently used in darktable 3.4 is 6.1.0. + +# Development API + +The current Lua API is currently at version 6.2.0 in the development branch of darktable \(currently 3.5\). All changes for version 6.2.0 will be identified as such until version 6.2.0 is included in a darktable release. \ No newline at end of file