leviathan
/
pEpJSONServerAdapter
forked from pEp.foundation/pEpJSONServerAdapter
1
0
Fork 0
Code Issues 0 Pull Requests 0 Projects 0 Releases 0 Wiki Activity
p≡p JSON adapter
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
221 Commits
80 Branches
6.7 MiB
Tree: 26691a4cf0
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '26691a4cf0'
${ noResults }
pEpJSONServerAdapter/API reference.md

95 lines
4.4 KiB
Raw Normal View History

added API reference as generated Markdown file.
5 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
update "API reference.md" to show InOut parameters, too
5 years ago
​
added API reference as generated Markdown file.
5 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
 
  1. ### Function reference for the p≡p JSON Server Adapter. Version “(29) Wenden” ###

  2. Output parameters are denoted by a  **⇑** , InOut parameters are denoted by a  **⇕**  after the parameter type.
  3. 

  4. #### Message API ####

  5. | Function name | Return Type | Parameters |
  6. |---------------|-------------|------------|
  7. | MIME_encrypt_message | PEP_STATUS | String, Integer, StringList, String⇑, PEP_enc_format, Integer |
  8. | MIME_encrypt_message_for_self | PEP_STATUS | Identity, String, Integer, String⇑, PEP_enc_format, Integer |
  9. | MIME_decrypt_message | PEP_STATUS | String, Integer, String⇑, StringList⇑, PEP_rating⇑, Integer⇑ |
  10. | MIME_encrypt_message_ex | PEP_STATUS | String, Integer, StringList, Bool, String⇑, PEP_enc_format, Integer |
  11. | MIME_decrypt_message_ex | PEP_STATUS | String, Integer, Bool, String⇑, StringList⇑, PEP_rating⇑, Integer⇑ |
  12. | startKeySync | Void |  |
  13. | stopKeySync | Void |  |
  14. | startKeyserverLookup | Void |  |
  15. | stopKeyserverLookup | Void |  |
  16. | encrypt_message | PEP_STATUS | Message, StringList, Message⇑, PEP_enc_format, Integer |
  17. | encrypt_message_for_self | PEP_STATUS | Identity, Message, Message⇑, PEP_enc_format, Integer |
  18. | decrypt_message | PEP_STATUS | Message, Message⇑, StringList⇑, PEP_rating⇑, Integer⇑ |
  19. | outgoing_message_rating | PEP_STATUS | Message, PEP_rating⇑ |
  20. | re_evaluate_message_rating | PEP_STATUS | Message, StringList, PEP_rating, PEP_rating⇑ |
  21. | identity_rating | PEP_STATUS | Identity, PEP_rating⇑ |
  22. | get_gpg_path | PEP_STATUS | String⇑ |
  23. 

  24. 

  25. #### pEp Engine Core API ####

  26. | Function name | Return Type | Parameters |
  27. |---------------|-------------|------------|
  28. | log_event | PEP_STATUS | String, String, String, String |
  29. | get_trustwords | PEP_STATUS | Identity, Identity, Language, String⇑, Integer⇑, Bool |
  30. | get_languagelist | PEP_STATUS | String⇑ |
  31. | get_phrase | PEP_STATUS | Language, Integer, String⇑ |
  32. | get_engine_version | String |  |
  33. | config_passive_mode | Void | Bool |
  34. | config_unencrypted_subject | Void | Bool |
  35. 

  36. 

  37. #### Identity Management API ####

  38. | Function name | Return Type | Parameters |
  39. |---------------|-------------|------------|
  40. | get_identity | PEP_STATUS | String, String, Identity⇑ |
  41. | set_identity | PEP_STATUS | Identity |
  42. | mark_as_comprimized | PEP_STATUS | String |
  43. | identity_rating | PEP_STATUS | Identity, PEP_rating⇑ |
  44. | outgoing_message_rating | PEP_STATUS | Message, PEP_rating⇑ |
  45. | set_identity_flags | PEP_STATUS | Identity⇕, Integer |
  46. | unset_identity_flags | PEP_STATUS | Identity⇕, Integer |
  47. 

  48. 

  49. #### Low level Key Management API ####

  50. | Function name | Return Type | Parameters |
  51. |---------------|-------------|------------|
  52. | generate_keypair | PEP_STATUS | Identity⇕ |
  53. | delete_keypair | PEP_STATUS | String |
  54. | import_key | PEP_STATUS | String, Integer, IdentityList⇑ |
  55. | export_key | PEP_STATUS | String, String⇑, Integer⇑ |
  56. | find_keys | PEP_STATUS | String, StringList⇑ |
  57. | get_trust | PEP_STATUS | Identity⇕ |
  58. | own_key_is_listed | PEP_STATUS | String, Bool⇑ |
  59. | own_identities_retrieve | PEP_STATUS | IdentityList⇑ |
  60. | myself | PEP_STATUS | Identity⇕ |
  61. | update_dentity | PEP_STATUS | Identity⇕ |
  62. | trust_personal_key | PEP_STATUS | Identity |
  63. | key_mistrusted | PEP_STATUS | Identity |
  64. | key_reset_trust | PEP_STATUS | Identity |
  65. | least_trust | PEP_STATUS | String, PEP_comm_type⇑ |
  66. | get_key_rating | PEP_STATUS | String, PEP_comm_type⇑ |
  67. | renew_key | PEP_STATUS | String, Timestamp |
  68. | revoke | PEP_STATUS | String, String |
  69. | key_expired | PEP_STATUS | String, Integer, Bool⇑ |
  70. 

  71. 

  72. #### from blacklist.h & OpenPGP_compat.h ####

  73. | Function name | Return Type | Parameters |
  74. |---------------|-------------|------------|
  75. | blacklist_add | PEP_STATUS | String |
  76. | blacklist_delete | PEP_STATUS | String |
  77. | blacklist_is_listed | PEP_STATUS | String, Bool⇑ |
  78. | blacklist_retrieve | PEP_STATUS | StringList⇑ |
  79. | OpenPGP_list_keyinfo | PEP_STATUS | String, StringPairList⇑ |
  80. 

  81. 

  82. #### Event Listener & Results ####

  83. | Function name | Return Type | Parameters |
  84. |---------------|-------------|------------|
  85. | registerEventListener | PEP_STATUS | String, Integer, String |
  86. | unregisterEventListener | PEP_STATUS | String, Integer, String |
  87. | deliverHandshakeResult | PEP_STATUS | Identity, PEP_sync_handshake_result |
  88. 

  89. 

  90. #### Other ####

  91. | Function name | Return Type | Parameters |
  92. |---------------|-------------|------------|
  93. | version | String |  |
  94. | apiVersion | Integer |  |
  95. | getGpgEnvironment | GpgEnvironment |  |