Browse Source

rename mis-spelled undo_last_mitrust() into undo_last_mistrust(). API version 0.12.0.

JSON-77
Roker 4 years ago
parent
commit
73b6365fcd
3 changed files with 22 additions and 60 deletions
  1. +19
    -58
      API reference details.md
  2. +1
    -1
      server/ev_server.cc
  3. +2
    -1
      server/server_version.cc

+ 19
- 58
API reference details.md View File

@ -31,31 +31,6 @@ encrypt a MIME message, with MIME output
will remain in the ownership of the caller
##### MIME_encrypt_message_for_self(Identity target_id, String mimetext, Integer size, String⇑ mime_ciphertext, PEP_enc_format enc_format, Integer flags)
encrypt MIME message for user's identity only, ignoring recipients and other identities from
the message, with MIME output.
```
parameters:
target_id (in) self identity this message should be encrypted for
mimetext (in) MIME encoded text to encrypt
size (in) size of input mime text
mime_ciphertext (out) encrypted, encoded message
enc_format (in) encrypted format
flags (in) flags to set special encryption features
return value:
PEP_STATUS_OK if everything worked
PEP_BUFFER_TOO_SMALL if encoded message size is too big to handle
PEP_CANNOT_CREATE_TEMP_FILE
if there are issues with temp files; in
this case errno will contain the underlying
error
PEP_OUT_OF_MEMORY if not enough memory could be allocated
```
##### MIME_decrypt_message(String mimetext, Integer size, String⇑ mime_plaintext, StringList⇑ keylist, PEP_rating⇑ rating, Integer⇑ flags)
decrypt a MIME message, with MIME output
@ -81,12 +56,6 @@ decrypt a MIME message, with MIME output
```
##### MIME_encrypt_message_ex(String, Integer, StringList, Bool, String⇑, PEP_enc_format, Integer )
(deprecated)
##### MIME_decrypt_message_ex(String, Integer, Bool, String⇑, StringList⇑, PEP_rating⇑, Integer⇑ )
(deprecated)
##### startKeySync()
Start Key Synchronization for the current session.
@ -218,18 +187,6 @@ re-evaluate already decrypted message rating
get path of gpg binary.
#### pEp Engine Core API ####
##### log_event(String title, String entity, String description, String comment)
log a user defined event defined by UTF-8 encoded strings into management log
```
parameters:
title (in) C string with event name
entity (in) C string with name of entity which is logging
description (in) C string with long description for event or NULL if omitted
comment (in) C string with user defined comment or NULL if omitted
return value:
PEP_STATUS_OK log entry created
```
##### get_trustwords(Identity id1, Identity id2, Language lang, String⇑ words, Integer⇑ wsize, Bool full)
get full trustwords string for a *pair* of identities
@ -262,22 +219,18 @@ get the list of languages
column 2 is the name of the language
```
##### get_phrase(Language lang, Integer phrase_id, String⇑ phrase)
get phrase in a dedicated language through i18n
##### is_pep_user(Identity id, Bool⇑ ia_pwp)
returns true if the USER corresponding to this identity has been listed in the *person* table as a pEp user
```
parameters:
lang (in) C string with ISO 639-1 language code
phrase_id (in) id of phrase in i18n
phrase (out) phrase as UTF-8 string
parameters:
identity (in) - identity containing the user_id to check (this is
the only part of the struct we require to be set)
is_pep (out) - boolean pointer - will return true or false by
reference with respect to whether or not user is
a known pep user
```
##### get_engine_version()
returns the current version of pEpEngine (this is different from the pEp protocol version!)
* parameters: (none)
* return_value: String containing the engine version string constant
##### config_passive_mode(Bool enable)
enable passive mode
@ -468,7 +421,7 @@ returns true id key is listed as own key
```
parameters:
fpr (in) fingerprint of key to test
listed (out) flags if key is own
listed (out) flags if key is own
```
##### own_identities_retrieve(IdentityList⇑ own_identities)
@ -478,6 +431,14 @@ retrieve all own identities
own_identities (out) list of own identities
```
##### set_own_key( Identity⇕ id, String fpr)
mark key as own key
```
parameters:
me (inout) own identity this key is used for
fpr (in) fingerprint of the key to mark as own key
```
##### myself(Identity⇕ identity)
ensures that the own identity is being complete
```
@ -494,7 +455,7 @@ ensures that the own identity is being complete
with retrieve_next_identity() where pEp_identity.me is true.
```
##### update_dentity(Identity⇕)
##### update_identity(Identity⇕)
update identity information
```
parameters:


+ 1
- 1
server/ev_server.cc View File

@ -99,7 +99,7 @@ const FunctionMap functions = {
FP( "own_key_is_listed", new Func<PEP_STATUS, In<PEP_SESSION,false>, In<c_string>, Out<bool>> ( &own_key_is_listed) ),
FP( "own_identities_retrieve", new Func<PEP_STATUS, In<PEP_SESSION,false>, Out<identity_list*>>( &own_identities_retrieve ) ),
FP( "set_own_key", new Func<PEP_STATUS, In<PEP_SESSION,false>, InOut<pEp_identity*>, In<c_string>>( &set_own_key ) ),
FP( "undo_last_mitrust", new Func<PEP_STATUS, In<PEP_SESSION,false>>( &undo_last_mistrust ) ),
FP( "undo_last_mistrust", new Func<PEP_STATUS, In<PEP_SESSION,false>>( &undo_last_mistrust ) ),
FP( "myself" , new Func<PEP_STATUS, In<PEP_SESSION,false>, InOut<pEp_identity*>> ( &myself) ),
FP( "update_identity", new Func<PEP_STATUS, In<PEP_SESSION,false>, InOut<pEp_identity*>> ( &update_identity) ),


+ 2
- 1
server/server_version.cc View File

@ -45,7 +45,8 @@ static const std::string version_name =
//const ServerVersion sv{0, 10, 0, version_name}; // first version defined.
const ServerVersion sv{0, 11, 0, version_name}; // add set_own_key()
//const ServerVersion sv{0, 11, 0, version_name}; // add set_own_key()
const ServerVersion sv{0, 12, 0, version_name}; // rename mis-spelled undo_last_mitrust() into undo_last_mistrust()
} // end of anonymous namespace
////////////////////////////////////////////////////////////////////////////


Loading…
Cancel
Save