API reference.md
author Roker <roker@pep-project.org>
Thu, 07 Jun 2018 12:44:11 +0200
branchJSON-93
changeset 537 ff1cdc290c32
parent 505 0fa0fa164f4f
child 619 4ad8b10e6021
permissions -rw-r--r--
JSON-94: re-implement combining of UTF-16 surrogate pairs. the 1st implementation was nuts. :-9
     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 
     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, StringList, String⇑, PEP_enc_format, Integer |
     9 | MIME_decrypt_message | PEP_STATUS | String, Integer, String⇑, StringList⇑, PEP_rating⇑, Integer⇕, String⇑ |
    10 | startKeySync | Void |  |
    11 | stopKeySync | Void |  |
    12 | startKeyserverLookup | Void |  |
    13 | stopKeyserverLookup | Void |  |
    14 | encrypt_message | PEP_STATUS | Message, StringList, Message⇑, 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 
    20 
    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 
    30 
    31 #### Identity Management API ####
    32 | Function name | Return Type | Parameters |
    33 |---------------|-------------|------------|
    34 | get_identity | PEP_STATUS | String, String, Identity⇑ |
    35 | set_identity | PEP_STATUS | Identity |
    36 | mark_as_comprimized | PEP_STATUS | String |
    37 | identity_rating | PEP_STATUS | Identity, PEP_rating⇑ |
    38 | outgoing_message_rating | PEP_STATUS | Message, PEP_rating⇑ |
    39 | set_identity_flags | PEP_STATUS | Identity⇕, Integer |
    40 | unset_identity_flags | PEP_STATUS | Identity⇕, Integer |
    41 
    42 
    43 #### Low level Key Management API ####
    44 | Function name | Return Type | Parameters |
    45 |---------------|-------------|------------|
    46 | generate_keypair | PEP_STATUS | Identity⇕ |
    47 | delete_keypair | PEP_STATUS | String |
    48 | import_key | PEP_STATUS | String, Integer, IdentityList⇑ |
    49 | export_key | PEP_STATUS | String, String⇑, Integer⇑ |
    50 | find_keys | PEP_STATUS | String, StringList⇑ |
    51 | get_trust | PEP_STATUS | Identity⇕ |
    52 | own_key_is_listed | PEP_STATUS | String, Bool⇑ |
    53 | own_identities_retrieve | PEP_STATUS | IdentityList⇑ |
    54 | set_own_key | PEP_STATUS | Identity⇕, String |
    55 | undo_last_mistrust | PEP_STATUS |  |
    56 | myself | PEP_STATUS | Identity⇕ |
    57 | update_identity | PEP_STATUS | Identity⇕ |
    58 | trust_personal_key | PEP_STATUS | Identity |
    59 | key_mistrusted | PEP_STATUS | Identity |
    60 | key_reset_trust | PEP_STATUS | Identity |
    61 | least_trust | PEP_STATUS | String, PEP_comm_type⇑ |
    62 | get_key_rating | PEP_STATUS | String, PEP_comm_type⇑ |
    63 | renew_key | PEP_STATUS | String, Timestamp |
    64 | revoke | PEP_STATUS | String, String |
    65 | key_expired | PEP_STATUS | String, Integer, Bool⇑ |
    66 
    67 
    68 #### from blacklist.h & OpenPGP_compat.h ####
    69 | Function name | Return Type | Parameters |
    70 |---------------|-------------|------------|
    71 | blacklist_add | PEP_STATUS | String |
    72 | blacklist_delete | PEP_STATUS | String |
    73 | blacklist_is_listed | PEP_STATUS | String, Bool⇑ |
    74 | blacklist_retrieve | PEP_STATUS | StringList⇑ |
    75 | OpenPGP_list_keyinfo | PEP_STATUS | String, StringPairList⇑ |
    76 
    77 
    78 #### Event Listener & Results ####
    79 | Function name | Return Type | Parameters |
    80 |---------------|-------------|------------|
    81 | registerEventListener | Void | String, Integer, String |
    82 | unregisterEventListener | Void | String, Integer, String |
    83 | deliverHandshakeResult | PEP_STATUS | Identity, PEP_sync_handshake_result |
    84 
    85 
    86 #### Other ####
    87 | Function name | Return Type | Parameters |
    88 |---------------|-------------|------------|
    89 | serverVersion | ServerVersion |  |
    90 | version | String |  |
    91 | getGpgEnvironment | GpgEnvironment |  |
    92 | shutdown | Void |  |
    93