pEp.foundation
/
pEpJSONServerAdapter
10
2
Fork 4
Code Issues 1 Pull Requests Releases 1 Wiki Activity

rename mis-spelled undo_last_mitrust() into undo_last_mistrust(). API version 0.12.0. updated API reference.md and API reference detail.md

JSON-54
Roker 2018-02-26 15:51:14 +01:00
parent 73b6365fcd
commit 2b99fffa37
2 changed files with 30 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
API reference details.md
View File

@ -226,8 +226,8 @@ returns true if the USER corresponding to this identity has been listed in the *
parameters:
identity (in) - identity containing the user_id to check (this is
the only part of the struct we require to be set)
is_pep (out) - boolean pointer - will return true or false by
reference with respect to whether or not user is
is_pep (out) - boolean pointer - will return true or false by
reference with respect to whether or not user is
a known pep user
```
@ -439,6 +439,25 @@ mark key as own key
fpr (in) fingerprint of the key to mark as own key
```
##### undo_last_mistrust()
reset identity and trust status for the last`identity in this session marked
as mistrusted to their cached values from the time of mistrust
```
parameters:
(none)
return value:
PEP_STATUS_OK if identity and trust were successfully restored.
Otherwise, error status from attempts to set.
caveat:
only works for this session, and only once. cache is invalidated
upon use.
  WILL NOT WORK ON MISTRUSTED OWN KEY
```
##### myself(Identity⇕ identity)
ensures that the own identity is being complete
```
@ -611,11 +630,14 @@ give the result of the handshake dialog back to the Engine
```
#### Other ####
##### serverVersion()
Returns a struct with SemVer-compatible ABI version, the codename of the
JSON Adapter version etc.
##### version()
Returns a codename for the current JSON Server Adapter's version.
##### apiVersion()
Returns a numerical API version, currently the API version is 2.
##### getGpgEnvironment()
Returns a struct holding 3 members
@ -623,3 +645,5 @@ Returns a struct holding 3 members
* gnupg_home environment variable, if set
* gpg_agent_info environment variable, if set.
##### shutdown()
shutdown the JSON Adapter

4
API reference.md
View File

@ -1,4 +1,4 @@
### Function reference for the p≡p JSON Server Adapter. Version “(34) Erndtebrück”, API version 0.11.0 ###
### Function reference for the p≡p JSON Server Adapter. Version “(34) Erndtebrück”, API version 0.12.0 ###
Output parameters are denoted by a **⇑** , InOut parameters are denoted by a **⇕** after the parameter type.
#### Message API ####
@ -50,7 +50,7 @@ Output parameters are denoted by a **⇑** , InOut parameters are denoted by a
| own_key_is_listed | PEP_STATUS | String, Bool⇑ |
| own_identities_retrieve | PEP_STATUS | IdentityList⇑ |
| set_own_key | PEP_STATUS | Identity⇕, String |
| undo_last_mitrust | PEP_STATUS | |
| undo_last_mistrust | PEP_STATUS | |
| myself | PEP_STATUS | Identity⇕ |
| update_identity | PEP_STATUS | Identity⇕ |
| trust_personal_key | PEP_STATUS | Identity |