Added versioning information to the Lua API manual. Added documentation for the new darktable.password API change.
This commit is contained in:
parent
e76a08f7dd
commit
1069c2eb93
3 changed files with 57 additions and 1 deletions
|
@ -5,4 +5,3 @@ weight: 30
|
||||||
draft: false
|
draft: false
|
||||||
author: "people"
|
author: "people"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
42
content/lua.api.manual/darktable/password.md
Normal file
42
content/lua.api.manual/darktable/password.md
Normal file
|
@ -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.
|
15
content/lua.api.manual/version.md
Normal file
15
content/lua.api.manual/version.md
Normal file
|
@ -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.
|
Loading…
Reference in a new issue