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

generate current API reference.md

JSON-77
Roker 2018-02-26 15:22:05 +01:00
parent e46bcdb99d
commit 7184552208
2 changed files with 11 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
API reference.md
View File

@ -1,35 +1,27 @@
### Function reference for the p≡p JSON Server Adapter. Version “(30) Krombach” ###
### Function reference for the p≡p JSON Server Adapter. Version “(34) Erndtebrück”, API version 0.11.0 ###
Output parameters are denoted by a **⇑** , InOut parameters are denoted by a **⇕** after the parameter type.
#### Message API ####
| Function name | Return Type | Parameters |
|---------------|-------------|------------|
| MIME_encrypt_message | PEP_STATUS | String, Integer, StringList, String⇑, PEP_enc_format, Integer |
| MIME_encrypt_message_for_self | PEP_STATUS | Identity, String, Integer, String⇑, PEP_enc_format, Integer |
| MIME_decrypt_message | PEP_STATUS | String, Integer, String⇑, StringList⇑, PEP_rating⇑, Integer⇑ |
| MIME_encrypt_message_ex | PEP_STATUS | String, Integer, StringList, Bool, String⇑, PEP_enc_format, Integer |
| MIME_decrypt_message_ex | PEP_STATUS | String, Integer, Bool, String⇑, StringList⇑, PEP_rating⇑, Integer⇑ |
| startKeySync | Void | |
| stopKeySync | Void | |
| startKeyserverLookup | Void | |
| stopKeyserverLookup | Void | |
| encrypt_message | PEP_STATUS | Message, StringList, Message⇑, PEP_enc_format, Integer |
| encrypt_message_for_self | PEP_STATUS | Identity, Message, Message⇑, PEP_enc_format, Integer |
| decrypt_message | PEP_STATUS | Message, Message⇑, StringList⇑, PEP_rating⇑, Integer⇑ |
| outgoing_message_rating | PEP_STATUS | Message, PEP_rating⇑ |
| re_evaluate_message_rating | PEP_STATUS | Message, StringList, PEP_rating, PEP_rating⇑ |
| identity_rating | PEP_STATUS | Identity, PEP_rating⇑ |
| get_gpg_path | PEP_STATUS | String⇑ |
#### pEp Engine Core API ####
| Function name | Return Type | Parameters |
|---------------|-------------|------------|
| log_event | PEP_STATUS | String, String, String, String |
| get_trustwords | PEP_STATUS | Identity, Identity, Language, String⇑, Integer⇑, Bool |
| get_languagelist | PEP_STATUS | String⇑ |
| get_phrase | PEP_STATUS | Language, Integer, String⇑ |
| get_engine_version | String | |
| is_pep_user | PEP_STATUS | Identity, Bool⇑ |
| config_passive_mode | Void | Bool |
| config_unencrypted_subject | Void | Bool |
@ -57,8 +49,10 @@ Output parameters are denoted by a **⇑** , InOut parameters are denoted by a
| get_trust | PEP_STATUS | Identity⇕ |
| 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 | |
| myself | PEP_STATUS | Identity⇕ |
| update_dentity | PEP_STATUS | Identity⇕ |
| update_identity | PEP_STATUS | Identity⇕ |
| trust_personal_key | PEP_STATUS | Identity |
| key_mistrusted | PEP_STATUS | Identity |
| key_reset_trust | PEP_STATUS | Identity |
@ -82,14 +76,16 @@ Output parameters are denoted by a **⇑** , InOut parameters are denoted by a
#### Event Listener & Results ####
| Function name | Return Type | Parameters |
|---------------|-------------|------------|
| registerEventListener | PEP_STATUS | String, Integer, String |
| unregisterEventListener | PEP_STATUS | String, Integer, String |
| registerEventListener | Void | String, Integer, String |
| unregisterEventListener | Void | String, Integer, String |
| deliverHandshakeResult | PEP_STATUS | Identity, PEP_sync_handshake_result |
#### Other ####
| Function name | Return Type | Parameters |
|---------------|-------------|------------|
| serverVersion | ServerVersion | |
| version | String | |
| apiVersion | Integer | |
| getGpgEnvironment | GpgEnvironment | |
| shutdown | Void | |

2
html/interactive.js
View File

@ -571,7 +571,7 @@ function create_doc()
}
output =
fd.section_start + 'Function reference for the p≡p JSON Server Adapter. Version “' + server_version + '”' + fd.section_end
fd.section_start + 'Function reference for the p≡p JSON Server Adapter. Version “' + server_version_name + '”, API version ' + server_version + fd.section_end
+ 'Output parameters are denoted by a ' + fd.b_start + '⇑' + fd.b_end + ', '
+ 'InOut parameters are denoted by a ' + fd.b_start + '⇕' + fd.b_end + ' after the parameter type.\n\n'
+ output + fd.table_end;