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