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.

95 lines
4.4 KiB

  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. #### Message API ####
  4. | Function name | Return Type | Parameters |
  5. |---------------|-------------|------------|
  6. | MIME_encrypt_message | PEP_STATUS | String, Integer, StringList, String⇑, PEP_enc_format, Integer |
  7. | MIME_encrypt_message_for_self | PEP_STATUS | Identity, String, Integer, String⇑, PEP_enc_format, Integer |
  8. | MIME_decrypt_message | PEP_STATUS | String, Integer, String⇑, StringList⇑, PEP_rating⇑, Integer⇑ |
  9. | MIME_encrypt_message_ex | PEP_STATUS | String, Integer, StringList, Bool, String⇑, PEP_enc_format, Integer |
  10. | MIME_decrypt_message_ex | PEP_STATUS | String, Integer, Bool, String⇑, StringList⇑, PEP_rating⇑, Integer⇑ |
  11. | startKeySync | Void | |
  12. | stopKeySync | Void | |
  13. | startKeyserverLookup | Void | |
  14. | stopKeyserverLookup | Void | |
  15. | encrypt_message | PEP_STATUS | Message, StringList, Message⇑, PEP_enc_format, Integer |
  16. | encrypt_message_for_self | PEP_STATUS | Identity, Message, Message⇑, PEP_enc_format, Integer |
  17. | decrypt_message | PEP_STATUS | Message, Message⇑, StringList⇑, PEP_rating⇑, Integer⇑ |
  18. | outgoing_message_rating | PEP_STATUS | Message, PEP_rating⇑ |
  19. | re_evaluate_message_rating | PEP_STATUS | Message, StringList, PEP_rating, PEP_rating⇑ |
  20. | identity_rating | PEP_STATUS | Identity, PEP_rating⇑ |
  21. | get_gpg_path | PEP_STATUS | String⇑ |
  22. #### pEp Engine Core API ####
  23. | Function name | Return Type | Parameters |
  24. |---------------|-------------|------------|
  25. | log_event | PEP_STATUS | String, String, String, String |
  26. | get_trustwords | PEP_STATUS | Identity, Identity, Language, String⇑, Integer⇑, Bool |
  27. | get_languagelist | PEP_STATUS | String⇑ |
  28. | get_phrase | PEP_STATUS | Language, Integer, String⇑ |
  29. | get_engine_version | String | |
  30. | config_passive_mode | Void | Bool |
  31. | config_unencrypted_subject | Void | Bool |
  32. #### Identity Management API ####
  33. | Function name | Return Type | Parameters |
  34. |---------------|-------------|------------|
  35. | get_identity | PEP_STATUS | String, String, Identity⇑ |
  36. | set_identity | PEP_STATUS | Identity |
  37. | mark_as_comprimized | PEP_STATUS | String |
  38. | identity_rating | PEP_STATUS | Identity, PEP_rating⇑ |
  39. | outgoing_message_rating | PEP_STATUS | Message, PEP_rating⇑ |
  40. | set_identity_flags | PEP_STATUS | Identity⇕, Integer |
  41. | unset_identity_flags | PEP_STATUS | Identity⇕, Integer |
  42. #### Low level Key Management API ####
  43. | Function name | Return Type | Parameters |
  44. |---------------|-------------|------------|
  45. | generate_keypair | PEP_STATUS | Identity⇕ |
  46. | delete_keypair | PEP_STATUS | String |
  47. | import_key | PEP_STATUS | String, Integer, IdentityList⇑ |
  48. | export_key | PEP_STATUS | String, String⇑, Integer⇑ |
  49. | find_keys | PEP_STATUS | String, StringList⇑ |
  50. | get_trust | PEP_STATUS | Identity⇕ |
  51. | own_key_is_listed | PEP_STATUS | String, Bool⇑ |
  52. | own_identities_retrieve | PEP_STATUS | IdentityList⇑ |
  53. | myself | PEP_STATUS | Identity⇕ |
  54. | update_dentity | PEP_STATUS | Identity⇕ |
  55. | trust_personal_key | PEP_STATUS | Identity |
  56. | key_mistrusted | PEP_STATUS | Identity |
  57. | key_reset_trust | PEP_STATUS | Identity |
  58. | least_trust | PEP_STATUS | String, PEP_comm_type⇑ |
  59. | get_key_rating | PEP_STATUS | String, PEP_comm_type⇑ |
  60. | renew_key | PEP_STATUS | String, Timestamp |
  61. | revoke | PEP_STATUS | String, String |
  62. | key_expired | PEP_STATUS | String, Integer, Bool⇑ |
  63. #### from blacklist.h & OpenPGP_compat.h ####
  64. | Function name | Return Type | Parameters |
  65. |---------------|-------------|------------|
  66. | blacklist_add | PEP_STATUS | String |
  67. | blacklist_delete | PEP_STATUS | String |
  68. | blacklist_is_listed | PEP_STATUS | String, Bool⇑ |
  69. | blacklist_retrieve | PEP_STATUS | StringList⇑ |
  70. | OpenPGP_list_keyinfo | PEP_STATUS | String, StringPairList⇑ |
  71. #### Event Listener & Results ####
  72. | Function name | Return Type | Parameters |
  73. |---------------|-------------|------------|
  74. | registerEventListener | PEP_STATUS | String, Integer, String |
  75. | unregisterEventListener | PEP_STATUS | String, Integer, String |
  76. | deliverHandshakeResult | PEP_STATUS | Identity, PEP_sync_handshake_result |
  77. #### Other ####
  78. | Function name | Return Type | Parameters |
  79. |---------------|-------------|------------|
  80. | version | String | |
  81. | apiVersion | Integer | |
  82. | getGpgEnvironment | GpgEnvironment | |