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.

96 lines
4.3 KiB

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